Skip to content

Metadata Description

christian-rli edited this page Feb 6, 2019 · 44 revisions

Table with all Metadata keys and a short description

# Key Description Example
1 name File name or database table name oep_metadata_table_example_v14
2 title Human readable title Metadata Example Table
3 id Uniform Resource Identifier (URI) that unambiguously identifies the resource. This can be a URL on the data set. It can also be a DOI (Digital Object Identifier). https://example.com
4 description A description of the package. It should be usable as summary information for the entire package that is described by the metadata. Example table used to illustrate the metadata structure and meaning
5 language Language used within the described data structures (e.g. titles, descriptions). The language key can be repeated if more languages are used. Standard: IETF (BCP47) [en-GB, de-DE, fr-FR]
6 keywords An Array of string keywords to assist users searching for the package in catalogs. [example, template, test]
7 publicationDate Date of publishing. Date Format is ISO 8601 (YYYY-MM-DD) 2019-02-06
8 context Object. Contains name-value-pairs that describe the general setting, evironment or project leading to the creation or maintenance of this dataset.
8.1 homepage URL of Project https://openenergy-platform.org/
8.2 documentation URL of the projects source code https://github.com/OpenEnergyPlatform/examples/wiki/Metadata-Description
8.3 sourceCode URL of Project https://github.com/OpenEnergyPlatform
8.4 contact Reference to the creator or maintainer of the data set [email protected]
8.5 grantNo In a publicly funded Project: the identifying grant number 01AB2345
9 spatial Object. Contains name-value-pairs describing the spatial context of the contained data.
9.1 location In the case of data where the location can be described as a point. May come as coordinates, URI or addresses with street, house number and zip code 52.433509, 13.535855
9.2 extent Covered area. May be the name of a region, or the geometry of a bounding box. Europe
9.3 resolution Pixel size in case of a regular raster image. Reference to administrative level or other spatial division that is present as the smallest spatially distinguished unit size. 30 m
10 temporal Object. Time period covered in the data. Temporal information should either contain a "referenceDate" or the three keys describing a time series; in rare cases both. Use "none" for the ones that don't apply.
10.1 referenceDate Base year, month or day. Point in time for which the data is meant to be accurate. A census will generally have a reference year. A satellite image will have a reference date. Date Format is ISO 8601. 2016-01-01
10.2 start The beginning point in time of a time series. 2019-02-06T10:12:04+00:00
10.3 end The end point in time of a time series. 2019-02-07T10:12:04+00:00
10.4 resolution The time span between individual points of information in a time series. 30 s
11 sources List of Objects. Each object has all name-value-pairs
11.1 title Human readable title of the source, e.g. document title or organisation name IPCC Fifth Assessment Report
11.2 description Free text description of the data set. Scientific climate change report by the UN
11.3 path URL to original source https://www.ipcc.ch/site/assets/uploads/2018/02/ipcc_wg3_ar5_full.pdf
11.4 license License of the source. Complete name and license id in brackets. Standard: SPDX License List Creative Commons Zero v1.0 Universal (CC0-1.0)
11.5 copyright Organisation, institution or individual who holds copyright of the source Intergovernmental Panel on Climate Change 2014
12 licenses The license(s) under which the described package is provided. List of Objects. Each object has all name-value-pairs
12.1 name SPDX identifier ODbL-1.0
12.2 title Official (human readable) title Open Data Commons Open Database License 1.0
12.3 path A url-or-path string, that is a fully qualified HTTP address, or a relative POSIX path (see the url-or-path definition in Data Resource for details).
12.4 instruction short description of rights and restrictions You are free to share and change, but you must attribute, and share derivations under the same license.
12.5 attribution copyrightholder of the produced data set © Reiner Lemoine Institut
Clone this wiki locally