Explicit cube configuration
This page discusses how to configure your cube with the greatest control and flexibility by writing a
If you are new to using csvcubed, you may wish to begin with the quick start approach.
This page will introduce the main components that make up a
qube-config.json file, then provide you with links to
explore more advanced configuration.
Experience of writing basic JSON documents is assumed throughout this document. See this tutorial from DigitalOcean for an introduction to writing JSON.
qube-config.json file has two primary sections:
- Metadata This section is used to describe the data set's catalog information to aid discovery and to provide provenance and publication information.
- Column Definitions This section is used to describe each column in the CSV file; each column is classified, and optionally linked to existing data definitions.
All csvcubed outputs contain metadata which makes it easier to discover data publications. We use definitions from established vocabularies to enable you to contribute faster to the web of data.
Remember that you don't have to set everything; many of the fields are optional, but you should always include the
$schema property so that csvcubed can recognise the file.
More information on how to configure metadata can be found on the Metadata page
For a more detailed introduction on how to configure column definitions, see the Column definitions page.
After the configuration file's metadata section, the column definitions section should describe some or all of the columns defined in your CSV file. This helps csvcubed understand what type of columns you're using and whether there's anything missing.
Configuring the types of each of your columns is relatively straightforward. The following data set can be correctly configured with the JSON below it.
|Average Badger Weight / kg
More information on how to configure columns can be found on the Column definitions page.