Metadata Description

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	contact@example.com
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
13	contributors	The people or organizations who contributed to this Data Package. This has to be a list. Each object refers to one contributor. Every contributor must have a title and property. A path, email, role and organization properties are optional extras.
13.1	title	Name/title of the contributor (name for a person, name or title for an organization)	Jon Doe
13.2	email	E-mail address of the contributor	contact@example.com
13.3	date	Date of the contribution. If the contribution took more than a day, use the date of the final contribiution. Date Format is ISO 8601.	2016-06-16
13.4	object	Target of contribution. Which part of the package was supplied/changed	Metadata
13.5	comment	Free text comment on what's been done	Fixed a typo in the title
14	resources	The Data Resource format describes a data resource such as an individual file or table.
14.1	profile	A string identifying the profile of this descriptor as per the profiles specification. This information is retained in order to comply with the "Tabular Data Package" standard. If at all in doubt the value should read "tabular-data-resource".	tabular-data-resource
14.2	name	A resource MUST contain a name unique to amongst all resources in this data package. To comply with the data package standard it must consist of only lowercase alphanumeric character plus ".", "-" and "_". It may not start with a number. In a database this will be the name of the table within its containing schema. It would be usual for the name to correspond to the file name (minus the file-extension) of the data file the resource describes.	sandbox.example_table
14.3	path	A url-or-path string, that should be a permanent http(s) address or other path directly linking to the resource.	https://openenergy-platform.org/dataedit/view/openstreetmap/osm_deu_roads
14.4	format	'csv', 'xls', 'json' etc. would be expected to be the standard file extension for this type of resource. When you upload your data to the OEDB, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data there are stored in a data base.	csv
14.5	encoding	Specifies the character encoding of the resource's data file. The values should be one of the "Preferred MIME Names" for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8.	UTF-8
14.6	schema	Object containing fields and primary key. Describes the structure of the present data.
14.6.1	fields	List of objects. Every object describes a column and provides name, description, type and unit.
14.6.1.1	name	Name string unique within its scope.	year
14.6.1.2	description	Free-text describing the field.	Reference year for which the data were collected.
14.6.1.3	type	Data type of the field.	integer
14.6.1.4	unit	Unit, preferably SI-Unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'none'	MW
14.6.2	primaryKey	A primary key is a field or set of fields that uniquely identifies each row in the table.	id
14.7	dialect	Object. A CSV Dialect defines a simple format to describe the various dialects of CSV files in a language agnostic manner. In case of a database, the values in the containing fields are "none".
14.7.1	delimiter	Specifies the character sequence which should separate fields (aka columns). Common characters are "," (comma), "." (point) and "\t" (tab).	,
14.7.2	decimalSeparator	Symbol used to separate the integer part from the fractional part of a number written in decimal form. Depending on language and region this symbol can be "." or ",".	.
15.	review	Data uploaded through the OEP needs to go through review. The review will cover the areas described here: https://github.com/OpenEnergyPlatform/data-preprocessing/wiki and carried out by a team of the platform. The review itself is documented at the specified path and a badge is rewarded with regards to completeness.
15.1	path	A URL or path string, that should be a permanent http(s) address directly linking to the documented review.	https://www.example.com
15.2	badge	A badge of either Bronze, Silver, Gold or Platin is used to label the given metadata based on its quality.	Platin
16	metaMetadata	Object. Description about the metadata themselves, their format, version and license. These fields should already be provided when you’re filling out your metadata.
16.1	metadataVersion	Type and version number of the metadata	OEP-1.4
16.2	metadataLicense	Object describing the license of the provided metadata
16.2.1	name	SPDX identifier	CC0-1.0
16.2.2	title	Official (human readable) license title	Creative Commons Zero v1.0 Universal
16.2.3	path	Url or path string, that is a fully qualified HTTP address	https://creativecommons.org/publicdomain/zero/1.0/
17	_comment	Array of objects. The “_comment”-section is used as a self-description of the final metadata-file. It is text, intended for humans and can include a link to the metadata documentation(s), required value formats and similar remarks. The comment section has no fix structure or mandatory values, but a useful self-description, similar to the one depicted here, is encouraged.
17.1	metadata	Reference to the metadata documentation in use.	"Metadata documentation and explanation (https://github.com/OpenEnergyPlatform/organisation/wiki/metadata)"
17.2	dates	Comment on data/time format	Dates and time must follow the ISO8601 including time zone (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh)
17.3	units	Comment on units	If you must use units in cells (which is discouraged), leave a space between numbers and units (100 m)
17.4	languages	Comment on language format	Languages must follow the IETF (BCP47) format (en-GB, en-US, de-DE)
17.5	licenses	Reference to license format	License name must follow the SPDX License List (https://spdx.org/licenses/)
17.6	review	Reference to review documentation	Following the OEP Data Review (https://github.com/OpenEnergyPlatform/data-preprocessing/wiki)
17.7	...	Feel free to add more descriptive comments. Like "none"	If a field is not applicable use fill it with "none"