transport_data.org.metadata.TDCALLReportStructure

class transport_data.org.metadata.TDCALLReportStructure(DATAFLOW: str, DATA_PROVIDER: str, URL: str, MEASURE: str, UNIT_MEASURE: str, DIMENSION: str, DATA_DESCR: str, METHOD: str, COMMENT: str)[source]

Bases: object

Concepts and metadata attributes in the TDC metadata structure.

__init__(DATAFLOW: str, DATA_PROVIDER: str, URL: str, MEASURE: str, UNIT_MEASURE: str, DIMENSION: str, DATA_DESCR: str, METHOD: str, COMMENT: str) None

Methods

__init__(DATAFLOW, DATA_PROVIDER, URL, ...)

Attributes

DATAFLOW

Data flow ID

DATA_PROVIDER

Data provider

URL

URL or web address

MEASURE

Measure (‘indicator’)

UNIT_MEASURE

Unit of measure

DIMENSION

Dimensions

DATA_DESCR

Data description

METHOD

Methodology

COMMENT

Comment

COMMENT: str

Comment

Any other information about the metadata values, for instance discrepancies or unclear or missing information.

Precede comments with initials; append to existing comments to keep chronological order; and include a date (for example, “2024-07-24”) if helpful.

DATAFLOW: str

Data flow ID

A unique identifier for the data flow (=data source, data set, etc.).

We suggest to use IDs like ‘VN001’, where ‘VN’ is the ISO 3166 alpha-2 country code, and ‘001’ is a unique number. The value MUST match the name of the sheet in which it appears.

DATA_DESCR: str

Data description

Any information about the data flow that does not fit in other attributes.

Until or unless other metadata attributes are added to this metadata structure/ template, this MAY include:

  • Any conditions on data access, e.g. publicly available, proprietary, fee or subscription required, available on request, etc.

  • Frequency of data updates.

  • Any indication of quality, including third-party references that indicate data quality.

DATA_PROVIDER: str

Data provider

Organization or individual that provides the data and any related metadata.

This can be as general (“IEA”) or specific (organization unit/department, specific person responsible, contact details, etc.) as appropriate.

DIMENSION: str

Dimensions

Formally, the “statistical concept used in combination with other statistical concepts to identify a statistical series or individual observations.

Record all dimensions of the data, either in a bulleted or numbered list, or separated by semicolons. In parentheses, give some indication of the scope and/or resolution of the data along each dimension. Most data have at least time and space dimensions.

Example:

  • TIME_PERIOD (annual, 5 years up to 2021)

  • REF_AREA (whole country; VN only)

  • Vehicle type (12 different types: […])

  • Emissions species (CO2 and 4 others)”””

MEASURE: str

Measure (‘indicator’)

Statistical concept for which data are provided in the data flow.

If the data flow contains data for multiple measures, give each one separated by semicolons. Example: “Number of cars; passengers per vehicle”.

This SHOULD NOT duplicate the value for ‘UNIT_MEASURE’. Example: “Annual driving distance per vehicle”, not “Kilometres per vehicle”.

METHOD: str

Methodology

Any information about methods used by the data provider to collect, process, or prepare the data.

UNIT_MEASURE: str

Unit of measure

Unit in which the data values are expressed.

If ‘MEASURE’ contains 2+ items separated by semicolons, give the respective units in the same way and order. If there are no units, write ‘dimensionless’, ‘1’, or similar.

URL: str

URL or web address

Location on the Internet with further information about the data flow.