table
A table is a collection of indicators that share the same index. The table metadata fields are the attributes of the TableMeta
object in ETL.
table.common
table.common.description_from_producer
type: string
| recommended (if existing)
Description of the indicator written by the producer, if any was given.
- Must start with a capital letter.
- Must end with a period.
- Should be identical to the producer's text, except for some formatting changes, typo corrections, or other appropriate minor edits.
- Should only be given if the producer clearly provides such definitions in a structured way. Avoid spending time searching for a definition given by the producer elsewhere.
table.common.description_key
type: array
, array
| recommended (for curated indicators)
List of key pieces of information about the indicator.
- Must be a list of one or more short paragraphs.
- Each paragraph must start with a capital letter.
- Each paragraph must end with a period.
- Must not contain
description_short
(although there might be some overlap of information). - Should contain all the key information about the indicator (except that already given in
description_short
). - Should include the key information given in other fields like
grapher_config.subtitle
(if different fromdescription_short
) andgrapher_config.note
. - Should not contain information about processing (which should be in
description_processing
). - Should only contain information that is key to the public.
- Anything that is too detailed or technical should be left in the code.
table.common.description_processing
type: string
| required (if applicable)
Relevant information about the processing of the indicator done by OWID.
- Must start with a capital letter.
- Must end with a period.
- Must be used if important editorial decisions have been taken during data processing.
- Must not be used to describe common processing steps like country harmonization.
- Should only contain key processing information to the public.
- Anything that is too detailed or technical should be left in the code.
table.common.description_short
type: string
| required
One or a few lines that complement the title to have a short description of the indicator.
- Must start with a capital letter.
- Must end with a period.
- Must be one short paragraph (for example suitable to fit in a chart subtitle).
- Should not mention any other metadata fields (like information about the processing, or the origins, or the units). Exceptions:
- The unit can be mentioned if it is crucial for the description.
table.common.display
We keep display for the time being as the 'less powerful sibling' of grapher config.
table.common.display.color
type: string
Color to use for the indicator in e.g. line charts.
table.common.display.conversionFactor
type: number
Conversion factor to apply to indicator values.
- Note: We should avoid using this, and instead convert data and units (and possibly other metadata fields where the units are mentioned) consistently in the ETL grapher step.
table.common.display.description
type: string
Description to display for the indicator, to replace the indicator's description
.
table.common.display.entityAnnotationsMap
type: string
Entity annotations
table.common.display.includeInTable
type: boolean
Whether to render this indicator in the table sheet.
table.common.display.isProjection
type: boolean
Indicates if this time series is a forward projection (if so then this is rendered differently in e.g. line charts).
table.common.display.name
type: string
| required
Title to display for the indicator, to replace the indicator's title
. NOTE: Currently, grapher_config.title
will be used only in charts, whereas display.name
will be used in other places, like the table tab.
- Must be suitable to be publicly displayed, even for 'big datasets' with many dimensions.
- Must start with a capital letter.
- Must not end with a period.
- Must be one short sentence (a few words).
- Should not mention other metadata fields like
producer
orversion
.
DO | DON'T |
---|---|
«Number of neutron star mergers in the Milky Way » |
«Number of neutron stars (NASA) » |
«Share of neutron star mergers that happen in the Milky Way » |
«Share of neutron star mergers that happen in the Milky Way (2023) » |
«Area harvested of barley » |
«Barley | 00000044 || Area harvested | 005312 || hectares » |
table.common.display.numDecimalPlaces
type: integer
Number of decimal places to show in charts (and in the table tab).
table.common.display.shortUnit
type: string
Short unit to use in charts instead of the indicator's short_unit
.
table.common.display.tableDisplay
Configuration for the table tab for this indicator, with options hideAbsoluteChange
and hideRelativeChange
.
table.common.display.tableDisplay.hideAbsoluteChange
type: boolean
Whether to hide the absolute change.
table.common.display.tableDisplay.hideRelativeChange
type: boolean
Whether to hide the relative change.
table.common.display.tolerance
type: integer
Tolerance (in years or days) to use in charts. If data points are missing, the closest data point will be shown, if it lies within the specified tolerance.
table.common.display.unit
type: string
Unit to use in charts instead of the indicator's unit
.
table.common.display.yearIsDay
type: boolean
Switch to indicate if the number in the year column represents a day (since zeroDay) or a year.
table.common.display.zeroDay
type: string
ISO date day string for the starting date if yearIsDay
is True
.
table.common.license
type: string
| required (in the future this could be automatic)
License of the indicator, which depends on the indicator's processing level and the origins' licenses.
- If the indicator's
processing_level
is major, assignCC BY 4.0
. - If the indicator's
processing_level
is minor, choose the most strict license among the origins'licenses
.
table.common.origins
type: array
List of all origins of the indicator.
- Note: Origins should be propagated automatically from snapshots. Therefore, this field should only be manually filled out if automatic propagation fails.
table.common.presentation
An indicator's presentation defines how the indicator's metadata will be shown on our website (e.g. in data pages). The indicator presentation metadata fields are the attributes of the VariablePresentationMeta
object in ETL.
table.common.presentation.attribution
type: string
| optional
Citation of the indicator's origins, to override the automatic format producer1 (year1); producer2 (year2)
.
- Must start with a capital letter. Exceptions:
- The name of the institution or the author must be spelled with small letter, e.g.
van Haasteren
.
- The name of the institution or the author must be spelled with small letter, e.g.
- Must join multiple attributions by a
;
. - Must not end in a period (and must not end in
;
). - Must contain the year of
date_published
, for each origin, in parenthesis. - Should only be used when the automatic format
producer1 (year1); producer2 (year2)
needs to be overridden.
DO | DON'T |
---|---|
«Energy Institute - Statistical Review of World Energy (2023); Ember (2022) » |
«UN (2023), WHO (2023) » |
table.common.presentation.attribution_short
type: string
| recommended (for curated indicators)
Very short citation of the indicator's main producer(s).
- Must start with a capital letter. Exceptions:
- The name of the institution or the author must be spelled with small letter, e.g.
van Haasteren
.
- The name of the institution or the author must be spelled with small letter, e.g.
- Must not end in a period.
- Should be very short.
- Should be used if the automatic concatenation of origin's
attribution_short
are too long. In those cases, choose the most importantattribution
(e.g. the main producer of the data).
table.common.presentation.faqs
type: array
| recommended (for curated indicators)
List of references to questions in an FAQ google document, relevant to the indicator.
- Each reference must contain
fragment_id
(question identifier) andgdoc_id
(document identifier).
table.common.presentation.grapher_config
Our World in Data grapher configuration. Most of the fields can be left empty and will be filled with reasonable default values.
Find more details on its attributes here.
table.common.presentation.grapher_config.$schema
type: string
Url of the concrete schema version to use to validate this document
table.common.presentation.grapher_config.addCountryMode
type: string
Whether the user can change countries, add additional ones or neither
table.common.presentation.grapher_config.baseColorScheme
type: string
The default color scheme if no color overrides are specified
table.common.presentation.grapher_config.colorScale
Color scale definition
table.common.presentation.grapher_config.colorScale.baseColorScheme
type: string
One of the predefined base color schemes
table.common.presentation.grapher_config.colorScale.binningStrategy
type: string
The strategy for generating the bin boundaries
table.common.presentation.grapher_config.colorScale.binningStrategyBinCount
type: integer
The suggested number of bins for the automatic binning algorithm
table.common.presentation.grapher_config.colorScale.colorSchemeInvert
type: boolean
Reverse the order of colors in the color scheme
table.common.presentation.grapher_config.colorScale.customCategoryColors
Map of categorical values to colors. Colors are CSS colors, usually in the form #aa9944
table.common.presentation.grapher_config.colorScale.customCategoryLabels
Map of category values to color legend labels.
table.common.presentation.grapher_config.colorScale.customHiddenCategories
Allow hiding categories from the legend
table.common.presentation.grapher_config.colorScale.customNumericColors
type: array
Override some or all colors for the numerical color legend.
Colors are CSS colors, usually in the form #aa9944
null
falls back the color scheme color.
table.common.presentation.grapher_config.colorScale.customNumericColorsActive
type: boolean
Whether customNumericColors
are used to override the color scheme
table.common.presentation.grapher_config.colorScale.customNumericLabels
type: array
Custom labels for each numeric bin. Only applied when strategy is manual
.
null
falls back to default label.
table.common.presentation.grapher_config.colorScale.customNumericMinValue
type: number
The minimum bracket of the first bin
table.common.presentation.grapher_config.colorScale.customNumericValues
type: array
Custom maximum brackets for each numeric bin. Only applied when strategy is manual
table.common.presentation.grapher_config.colorScale.equalSizeBins
type: boolean
Whether the visual scaling for the color legend is disabled.
table.common.presentation.grapher_config.colorScale.legendDescription
type: string
A custom legend description. Only used in ScatterPlot legend titles for now.
table.common.presentation.grapher_config.compareEndPointsOnly
type: boolean
Drops in between points in scatter plots
table.common.presentation.grapher_config.comparisonLines
type: array
List of vertical comparison lines to draw
table.common.presentation.grapher_config.data
Obsolete name - used only to store the available entities
table.common.presentation.grapher_config.data.availableEntities
type: array
List of available entities
table.common.presentation.grapher_config.dimensions
type: array
List of dimensions and their mapping to variables
table.common.presentation.grapher_config.entityType
type: string
Display string for naming the primary entities of the data. Default is 'country or region', but you can specify a different one such as 'state' or 'region'
table.common.presentation.grapher_config.entityTypePlural
type: string
Plural of the entity type (i.e. when entityType is 'country' this would be 'countries')
table.common.presentation.grapher_config.excludedEntities
type: array
Entities that should be excluded from the chart
table.common.presentation.grapher_config.facettingLabelByYVariables
type: string
Display string that replaces 'metric' in the 'Split by metric' label in facet controls (e.g. 'product' displays 'Split by product')
table.common.presentation.grapher_config.hasChartTab
type: boolean
Whether to show the (non-map) chart tab
table.common.presentation.grapher_config.hasMapTab
type: boolean
Whether the default chart for the indicator should include a map tab.
table.common.presentation.grapher_config.hideAnnotationFieldsInTitle
Whether to hide any automatically added title annotations like the selected year
table.common.presentation.grapher_config.hideAnnotationFieldsInTitle.changeInPrefix
type: boolean
Whether to hide "Change in" in relative line charts
table.common.presentation.grapher_config.hideAnnotationFieldsInTitle.entity
type: boolean
Whether to hide the entity annotation
table.common.presentation.grapher_config.hideAnnotationFieldsInTitle.time
type: boolean
Whether to hide the time annotation
table.common.presentation.grapher_config.hideConnectedScatterLines
type: boolean
Whether to hide connecting lines on scatter plots when a time range is selected
table.common.presentation.grapher_config.hideFacetControl
type: boolean
Whether to hide the faceting control
table.common.presentation.grapher_config.hideLegend
type: boolean
Hide legend in chart.
table.common.presentation.grapher_config.hideLinesOutsideTolerance
type: boolean
Hide entities without data for full time span (within tolerance)
table.common.presentation.grapher_config.hideLogo
type: boolean
Hide logo in chart.
table.common.presentation.grapher_config.hideRelativeToggle
type: boolean
Whether to hide the relative mode UI toggle. Default depends on the chart type
table.common.presentation.grapher_config.hideScatterLabels
type: boolean
Hide entity names in Scatter plots
table.common.presentation.grapher_config.hideTimeline
type: boolean
Whether to hide the timeline from the user. If it is hidden then the user can't change the time
table.common.presentation.grapher_config.hideTotalValueLabel
type: boolean
Whether to hide the total value label (used on stacked discrete bar charts)
table.common.presentation.grapher_config.id
type: integer
Internal DB id. Useful internally for OWID but not required if just using grapher directly.
table.common.presentation.grapher_config.includedEntities
type: array
Entities to include. Opposite of excludedEntities. If this is set then all entities not specified here are excluded.
table.common.presentation.grapher_config.internalNotes
type: string
Internal notes.
table.common.presentation.grapher_config.invertColorScheme
type: boolean
Reverse the order of colors in the color scheme
table.common.presentation.grapher_config.isExplorable
type: boolean
Legacy flag, should be removed
table.common.presentation.grapher_config.isPublished
type: boolean
Indicates if the chart is published on Our World in Data or still in draft
table.common.presentation.grapher_config.logo
type: string
Which logo to show on the upper right side
table.common.presentation.grapher_config.map
Configuration of the world map chart
table.common.presentation.grapher_config.map.colorScale
Color scale definition
# table.common.presentation.grapher_config.map.colorScale.baseColorScheme
type: string
One of the predefined base color schemes
# table.common.presentation.grapher_config.map.colorScale.binningStrategy
type: string
The strategy for generating the bin boundaries
# table.common.presentation.grapher_config.map.colorScale.binningStrategyBinCount
type: integer
The suggested number of bins for the automatic binning algorithm
# table.common.presentation.grapher_config.map.colorScale.colorSchemeInvert
type: boolean
Reverse the order of colors in the color scheme
# table.common.presentation.grapher_config.map.colorScale.customCategoryColors
Map of categorical values to colors. Colors are CSS colors, usually in the form #aa9944
# table.common.presentation.grapher_config.map.colorScale.customCategoryLabels
Map of category values to color legend labels.
# table.common.presentation.grapher_config.map.colorScale.customHiddenCategories
Allow hiding categories from the legend
# table.common.presentation.grapher_config.map.colorScale.customNumericColors
type: array
Override some or all colors for the numerical color legend.
Colors are CSS colors, usually in the form #aa9944
null
falls back the color scheme color.
# table.common.presentation.grapher_config.map.colorScale.customNumericColorsActive
type: boolean
Whether customNumericColors
are used to override the color scheme
# table.common.presentation.grapher_config.map.colorScale.customNumericLabels
type: array
Custom labels for each numeric bin. Only applied when strategy is manual
.
null
falls back to default label.
# table.common.presentation.grapher_config.map.colorScale.customNumericMinValue
type: number
The minimum bracket of the first bin
# table.common.presentation.grapher_config.map.colorScale.customNumericValues
type: array
Custom maximum brackets for each numeric bin. Only applied when strategy is manual
# table.common.presentation.grapher_config.map.colorScale.equalSizeBins
type: boolean
Whether the visual scaling for the color legend is disabled.
# table.common.presentation.grapher_config.map.colorScale.legendDescription
type: string
A custom legend description. Only used in ScatterPlot legend titles for now.
table.common.presentation.grapher_config.map.hideTimeline
type: boolean
Whether the timeline should be hidden in the map view and thus the user not be able to change the year
table.common.presentation.grapher_config.map.projection
type: string
Slightly misnamed - this does not change the map projection but instead specifies which world area to focus on.
table.common.presentation.grapher_config.map.time
type: number
, string
Select a specific time to be displayed.
table.common.presentation.grapher_config.map.timeTolerance
type: integer
Tolerance to use. If data points are missing for a time point, a match is accepted if it lies within the specified time period. The unit is the dominating time unit, usually years but can be days for daily time series.
table.common.presentation.grapher_config.map.toleranceStrategy
type: string
Tolerance strategy to use. Options include accepting matches that are "closest" to the time point in question (going forwards and backwards in time), and accepting matches that lie in the past ("backwards") or the future ("forwards").
table.common.presentation.grapher_config.map.tooltipUseCustomLabels
type: boolean
Show the label from colorSchemeLabels in the tooltip instead of the numeric value
table.common.presentation.grapher_config.map.variableId
type: integer
Variable ID to show. TODO: remove this and use dimensions instead
table.common.presentation.grapher_config.matchingEntitiesOnly
type: boolean
Exclude entities that do not belong in any color group
table.common.presentation.grapher_config.maxTime
type: number
, string
End point of the initially selected time span.
table.common.presentation.grapher_config.minTime
type: number
, string
Start point of the initially selected time span.
table.common.presentation.grapher_config.missingDataStrategy
type: string
The desired strategy for handling entities with missing data
table.common.presentation.grapher_config.note
type: string
Default footer note to use in charts for the indicator.
- Must start with a capital letter.
- Must end with a period.
- Must not include 'Note:' at the beginning (this is added automatically).
- Must be one short paragraph, usually one sentence, suitable to fit in a chart footer note.
- Should not mention any other metadata fields.
table.common.presentation.grapher_config.originUrl
type: string
The page containing this chart where more context can be found
table.common.presentation.grapher_config.relatedQuestions
type: array
Links to related questions
table.common.presentation.grapher_config.scatterPointLabelStrategy
type: string
When a user hovers over a connected series line in a ScatterPlot we show a label for each point. By default that value will be from the "year" column but by changing this option the column used for the x or y axis could be used instead.
table.common.presentation.grapher_config.selectedEntityColors
Colors for selected entities
table.common.presentation.grapher_config.selectedEntityNames
type: array
List of entities (e.g. harmonized country names) to use by default in charts for the indicator.
table.common.presentation.grapher_config.selectedFacetStrategy
type: string
The desired facetting strategy (none for no facetting)
table.common.presentation.grapher_config.showNoDataArea
type: boolean
Whether to show an area for entities that have no data (currently only used in marimekko charts)
table.common.presentation.grapher_config.showYearLabels
type: boolean
Whether to show year labels in bar charts
table.common.presentation.grapher_config.sortBy
type: string
Sort criterium (used by stacked bar charts and marimekko)
table.common.presentation.grapher_config.sortColumnSlug
type: string
Sort column if sortBy is column (used by stacked bar charts and marimekko)
table.common.presentation.grapher_config.sortOrder
type: string
Sort order (used by stacked bar charts and marimekko)
table.common.presentation.grapher_config.sourceDesc
type: string
Short comma-separated list of source names
table.common.presentation.grapher_config.stackMode
type: string
, null
Stack mode. Only absolute and relative are actively used.
table.common.presentation.grapher_config.subtitle
type: string
Default subtitle to use in charts for the indicator. NOTE: Use this field to override an indicator's description_short
with information that is more suitable for a chart subtitle.
- Must start with a capital letter.
- Must end with a period.
- Must be one short paragraph, suitable to fit in a chart subtitle.
table.common.presentation.grapher_config.tab
type: string
The tab that is shown initially
table.common.presentation.grapher_config.timelineMaxTime
type: integer
The highest year to show in the timeline. If this is set then the user is not able to see any data after this year
table.common.presentation.grapher_config.timelineMinTime
type: integer
The lowest year to show in the timeline. If this is set then the user is not able to see any data before this year
table.common.presentation.grapher_config.title
type: string
Default title to use in charts for the indicator, overriding the indicator's title
.
- Must start with a capital letter.
- Must not end with a period.
- Must be one short sentence (a few words).
- Must fit and be an appropriate choice for a chart's public title.
- Should not mention other metadata fields like
producer
orversion
.
table.common.presentation.grapher_config.type
type: string
Which type of chart should be shown (hasMapChart can be used to always also show a map chart)
table.common.presentation.grapher_config.variantName
type: string
Optional internal variant name for distinguishing charts with the same title
table.common.presentation.grapher_config.version
type: integer
table.common.presentation.grapher_config.xAxis
Axis definition
table.common.presentation.grapher_config.xAxis.canChangeScaleType
type: boolean
Allow user to change lin/log
table.common.presentation.grapher_config.xAxis.facetDomain
type: string
Whether the axis domain should be the same across faceted charts (if possible)
table.common.presentation.grapher_config.xAxis.label
type: string
Axis label
table.common.presentation.grapher_config.xAxis.max
type: number
Maximum domain value of the axis
table.common.presentation.grapher_config.xAxis.min
type: number
Minimum domain value of the axis
table.common.presentation.grapher_config.xAxis.removePointsOutsideDomain
type: boolean
table.common.presentation.grapher_config.xAxis.scaleType
type: string
Toggle linear/logarithmic
table.common.presentation.grapher_config.yAxis
Axis definition
table.common.presentation.grapher_config.yAxis.canChangeScaleType
type: boolean
Allow user to change lin/log
table.common.presentation.grapher_config.yAxis.facetDomain
type: string
Whether the axis domain should be the same across faceted charts (if possible)
table.common.presentation.grapher_config.yAxis.label
type: string
Axis label
table.common.presentation.grapher_config.yAxis.max
type: number
Maximum domain value of the axis
table.common.presentation.grapher_config.yAxis.min
type: number
Minimum domain value of the axis
table.common.presentation.grapher_config.yAxis.removePointsOutsideDomain
type: boolean
table.common.presentation.grapher_config.yAxis.scaleType
type: string
Toggle linear/logarithmic
table.common.presentation.grapher_config.zoomToSelection
type: boolean
Whether to zoom to the selected data points
table.common.presentation.title_public
type: string
| optional
Indicator title to be shown in data pages, that overrides the indicator's title.
- Must start with a capital letter.
- Must not end with a period.
- Must be one short sentence (a few words).
- Should not mention other metadata fields like
producer
orversion
. - Should help OWID and expert users identify the indicator.
- For big datasets where constructing human-readable titles is hard (e.g. FAOSTAT), consider using other metadata fields to improve the public appearance of the title (namely
presentation.title_public
andgrapher_config.title
).
table.common.presentation.title_variant
type: string
| optional
Short disambiguation of the title that references a special feature of the methods or nature of the data.
- Must start with a capital letter.
- Must not end in a period.
- Should be very short.
- Should only be used if the indicator's title is ambiguous (e.g. if there are multiple indicators with the same title).
- Should not reference the data provider. For that, instead, use
attribution_short
.
DO | DON'T |
---|---|
«Age-standardized » |
«The data is age-standardized » |
«Historical data » |
«Historical data from 1800 to 2010 » |
table.common.presentation.topic_tags
type: array
| recommended (for curated indicators)
List of topics where the indicator is relevant.
- Must be an existing topic tag, and be spelled correctly (see the list of topic tags in datasette (requires Tailscale).
- The first tag must correspond to the most relevant topic page (since that topic page will be used in citations of this indicator).
- Should contain 1, 2, or at most 3 tags.
table.common.presentation_license
License to display for the indicator, overriding license
.
table.common.presentation_license.name
type: string
table.common.presentation_license.url
type: string
table.common.processing_level
type: string
| required (in the future this could be automatic).
Level of processing that the indicator values have experienced.
- Must be
minor
if the indicator has undergone only minor operations since its origin:- Rename entities (e.g. countries or columns)
- Multiplication by a constant (e.g. unit change)
- Drop missing values.
- Must be
major
if any other operation is used:- Data aggregates (e.g. sum data for continents or income groups)
- Operations between indicators (e.g. per capita, percentages, annual changes)
- Concatenation of indicators, etc.
table.common.short_unit
type: string
| required
Characters that represent the unit we use to measure the indicator value.
- Must follow the rules of capitalization of the International System of Units, when applicable.
- Must not end with a period.
- Must be empty if the indicator has no units.
- Should not contain spaces.
- If, for clarity, we prefer to simplify the units in a chart, e.g. to show
kWh
instead ofkWh/person
, usedisplay.short_unit
for the simplified units, and keep the correct one inindicator.short_unit
(and ensure there is no ambiguity in the chart).
DO | DON'T |
---|---|
«t/ha » |
«t / ha » |
«% » |
«pct » |
«kWh/person » |
«pc » |
table.common.sources
type: array
List of all sources of the indicator. Automatically filled. NOTE: This is no longer in use, you should use origins.
table.common.title
type: string
| required
Title of the indicator, which is a few words definition of the indicator.
- Must start with a capital letter.
- Must not end with a period.
- Must be one short sentence (a few words).
- For 'small datasets', this should be the publicly displayed title. For 'big datasets' (like FAOSTAT, with many dimensions), it can be less human-readable, optimized for internal searches (then, use
display.name
for the publicly displayed title). - Should not mention other metadata fields like
producer
orversion
.
DO | DON'T |
---|---|
«Number of neutron star mergers in the Milky Way » |
«Number of neutron stars (NASA) » |
«Share of neutron star mergers that happen in the Milky Way » |
«Share of neutron star mergers that happen in the Milky Way (2023) » |
«Barley | 00000044 || Area harvested | 005312 || hectares » |
«Barley » |
table.common.unit
type: string
| required
Very concise name of the unit we use to measure the indicator values.
- Must not start with a capital letter.
- Must not end with a period.
- Must be empty if the indicator has no units.
- Must be in plural.
- Must be a metric unit when applicable.
- Should not use symbols like “/”.
- If it is a derived unit, use 'per' to denote a division, e.g. '... per hectare', or '... per person'.
- Should be '%' for percentages.
DO | DON'T |
---|---|
«tonnes per hectare » |
«tonnes/hectare » |
«kilowatts per person » |
«kilowatts per capita » |
table.description
type: string
| recommended (often automatic)
Description of the table (mostly for internal purposes, or for users of our data catalog) which is a one- (or a few) paragraph description of the table.
- Must start with a capital letter.
- Must end with a period.
- Should not mention other metadata fields (e.g.
producer
ordate_published
). Exceptions:- The other metadata fields are crucial in the description of the data product.
- Should ideally contain just one or a few paragraphs, that describe its content succinctly.
- Should be used only to override the automatic description (which usually is the description of the origin). For example, use it when the table has multiple origins.
table.title
type: string
| required (often automatic)
Title of the table (mostly for internal purposes, or for users of our data catalog) which is a few words description of the table.
- Must start with a capital letter.
- Must not end with a period.
- Should identify the table.
- Should be used only to override the automatic title (which usually is the title of the origin). For example, use it when the table has multiple origins.
table.variables
An indicator (also commonly called 'variable') is a collection of data points (usually a time series) with metadata. The indicator metadata fields are the attributes of the VariableMeta
object in ETL.