diff --git a/metadata/v200_draft/metadata_key_description.md b/metadata/v200_draft/metadata_key_description.md index 28ea19c..c8c4c3b 100644 --- a/metadata/v200_draft/metadata_key_description.md +++ b/metadata/v200_draft/metadata_key_description.md @@ -33,187 +33,166 @@ The JSON format offers different formats: ### General Keys -|#|Key |Description |Example | -|---|---|---|---| -| 1 | name | A file name or database table name. | oep_metadata_table_example_v16 | -| 2 | title | A human readable full title including author. | RLI - OEMetadata - Metadata example table | -| 3 | id | An Uniform Resource Identifier (URI) that unambiguously identifies the resource. This can be a URL on the data set. It can also be a Digital Object Identifier (DOI). | https://example.com | -| 4 | description | A description or abstract 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 | An array of languages 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 | **subject** | An array of objects with topics of the data in OEO terms. | -| 6.1 | name | The class label of the OEO terms. | energy | -| 6.2 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000150 | -| 7 | keywords | An array of keywords to assist users searching for the package in catalogs. | example, template, test | -| 8 | publicationDate | A date of publishing of the data or metadata. Date format is ISO 8601 (YYYY-MM-DD). | 2019-02-06 | -| 9 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | -| 9.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | -| 9.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | -| 9.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | +| # | Key | Description | Example | +|-----|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------| +| 1 | name | A file name or database table name. | oep_metadata_table_example_v16 | +| 2 | title | A human readable full title including author. | RLI - OEMetadata - Metadata example table | +| 3 | id | An Uniform Resource Identifier (URI) that unambiguously identifies the resource. This can be a URL on the data set. It can also be a Digital Object Identifier (DOI). | https://example.com | +| 4 | description | A description or abstract 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 | An array of languages 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 | **subject** | An array of objects with topics of the data in OEO terms. | +| 6.1 | name | The class label of the OEO terms. | energy | +| 6.2 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000150 | +| 7 | keywords | An array of keywords to assist users searching for the package in catalogs. | example, template, test | +| 8 | publicationDate | A date of publishing of the data or metadata. Date format is ISO 8601 (YYYY-MM-DD). | 2019-02-06 | +| 9 | **embargoPeriod** | An object that describes the embargo period during which public access to the data is not allowed. | +| 9.1 | start | The start date of the embargo period. The date of the data (metadata) upload. | 2024-10-11 | +| 9.2 | end | The end date of the embargo period. This is the envisioned publication date. | 2025-01-01 | +| 9.3 | isActive | A boolean key that indicates if the embargo period is currently active. Must be changed to False on the embargo period end date. | True | ### Context Keys -|#|Key |Description |Example | -|---|---|---|---| -| 10 | **context** | An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science this is can be the research project. | | -| 10.1 | homepage | A URL of the project. | https://openenergy-platform.org/ | -| 10.2 | documentation | A URL of the project documentation. | https://openenergy-platform.org/about/ | -| 10.3 | sourceCode | A URL of the projects source code. | https://github.com/OpenEnergyPlatform | -| 10.4 | contact | A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle. | contact@example.com | -| 10.5 | grantNo | An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency. | 01AB2345 | -| 10.6 | fundingAgency | A name of the entity providing the funding. This can be a government agency or a company. | Bundesministerium für Wirtschaft und Klimaschutz | -| 10.7 | fundingAgencyLogo | A URL to the logo or image of the funding agency. | https://commons.wikimedia.org/wiki/File:BMWi_Logo_2021.svg#/media/File:BMWi_Logo_2021.svg | -| 10.8 | publisherLogo | A URL to the logo of the publishing agency of data. | https://reiner-lemoine-institut.de//wp-content/uploads/2015/09/rlilogo.png | +| # | Key | Description | Example | +|------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| 10 | **context** | An object that describes the general setting, environment, or project leading to the creation or maintenance of this dataset. In science this is can be the research project. | | +| 10.1 | homepage | A URL of the project. | https://openenergy-platform.org/ | +| 10.2 | documentation | A URL of the project documentation. | https://openenergy-platform.org/about/ | +| 10.3 | sourceCode | A URL of the projects source code. | https://github.com/OpenEnergyPlatform | +| 10.4 | contact | A reference to the creator or maintainer of the data set. It can be an email address or a GitHub handle. | contact@example.com | +| 10.5 | grantNo | An identifying grant number. In case of a publicly funded project, this number is assigned by the funding agency. | 01AB2345 | +| 10.6 | fundingAgency | A name of the entity providing the funding. This can be a government agency or a company. | Bundesministerium für Wirtschaft und Klimaschutz | +| 10.7 | fundingAgencyLogo | A URL to the logo or image of the funding agency. | https://commons.wikimedia.org/wiki/File:BMWi_Logo_2021.svg#/media/File:BMWi_Logo_2021.svg | +| 10.8 | publisherLogo | A URL to the logo of the publishing agency of data. | https://reiner-lemoine-institut.de//wp-content/uploads/2015/09/rlilogo.png | ### Spatial and Temporal Keys -|#|Key |Description |Example | -|---|---|---|---| -| 11 | **spatial** | An object that describes the spatial context of the data it contains. | | -| 11.1 | location | A location of the data. In case of data where the location can be described as a point. May be specified as coordinates, URI or addresses with street, house number and zip code. | 52.433509, 13.535855 | -| 11.2 | extent | A covered area. May be the name of a region, or the geometry of a bounding box. | Europe | -| 11.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. | 1 ha | -| 11 | **temporal** | An object with the time period covered in the data. Temporal information should either contain a "referenceDate" or the keys describing a time series; in rare cases both. | | -| 12.1 | referenceDate | The base year, month or day. Point in time for which the data is meant to be accurate. The census data or a satellite image will have a reference date. Date Format is ISO 8601. | 2016-01-01 | -| 12.2 | **timeseries** | An array that describes the timeseries. || -| 12.2.1 | start | The beginning point in time of a time series. | 2019-02-06T10:12:04+00:00 | -| 12.2.2 | end | The end point in time of a time series. | 2019-02-07T10:12:04+00:00 | -| 12.2.3 | resolution | The time span between individual points of information in a time series. | 30 s | -| 12.2.4 | alignment | An indicator whether stamps in a time series are left, right or middle. | left | -| 12.2.5 | aggregationType | Indicates whether the values are a sum, average or current. | sum | +| # | Key | Description | Example | +|--------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| 11 | **spatial** | An object that describes the spatial context of the data it contains. | | +| 11.1 | location | A location of the data. In case of data where the location can be described as a point. May be specified as coordinates, URI or addresses with street, house number and zip code. | 52.433509, 13.535855 | +| 11.2 | extent | A covered area. May be the name of a region, or the geometry of a bounding box. | Europe | +| 11.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. | 1 ha | +| 12 | **temporal** | An object with the time period covered in the data. Temporal information should either contain a "referenceDate" or the keys describing a time series; in rare cases both. | | +| 12.1 | referenceDate | The base year, month or day. Point in time for which the data is meant to be accurate. The census data or a satellite image will have a reference date. Date Format is ISO 8601. | 2016-01-01 | +| 12.2 | **timeseries** | An array that describes the timeseries. | | +| 12.2.1 | start | The beginning point in time of a time series. | 2019-02-06T10:12:04+00:00 | +| 12.2.2 | end | The end point in time of a time series. | 2019-02-07T10:12:04+00:00 | +| 12.2.3 | resolution | The time span between individual points of information in a time series. | 30 s | +| 12.2.4 | alignment | An indicator whether stamps in a time series are left, right or middle. | left | +| 12.2.5 | aggregationType | Indicates whether the values are a sum, average or current. | sum | ### Source Keys -|#|Key |Description |Example | -|---|---|---|---| -| 12 | **sources** | An array of objects with the used and underlying sources of the data and metadata. | | -| 12.1 | title | A human readable title of the source, a document title or organisation name. | IPCC Fifth Assessment Report | -| 12.2 | description | A free text description of the data set. | Scientific climate change report by the UN | -| 12.3 | path | A URL to the original source. | https://www.ipcc.ch/site/assets/uploads/2018/02/ipcc_wg3_ar5_full.pdf | -| 12.4 | **licenses** | An array of objects under which the source is provided. | | -| 12.4.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | -| 12.4.2 | title | The official (human readable) title of the license. | Open Data Commons Open Database License 1.0 | -| 12.4.3 | path | A link to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | -| 12.4.4 | instruction | A short description of rights and restrictions. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information. | -| 12.4.5 | attribution | The copyright owner of the **source**. If attribution licenses are used, that name must be acknowledged. | © Intergovernmental Panel on Climate Change 2014 | -| 12.4.6 | copyrightStatement | A link or path that proves that the source or data has the appropriate license. | https://www.marktstammdatenregister.de/MaStR/Startseite/Impressum | +| # | Key | Description | Example | +|--------|--------------------|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 13 | **sources** | An array of objects with the used and underlying sources of the data and metadata. | | +| 13.1 | title | A human readable title of the source, a document title or organisation name. | IPCC Fifth Assessment Report | +| 13.2 | description | A free text description of the data set. | Scientific climate change report by the UN | +| 13.3 | path | A URL to the original source. | https://www.ipcc.ch/site/assets/uploads/2018/02/ipcc_wg3_ar5_full.pdf | +| 13.4 | **licenses** | An array of objects under which the source is provided. | | +| 13.4.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | +| 13.4.2 | title | The official (human readable) title of the license. | Open Data Commons Open Database License 1.0 | +| 13.4.3 | path | A link to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | +| 13.4.4 | instruction | A short description of rights and restrictions. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information. | +| 13.4.5 | attribution | The copyright owner of the **source**. If attribution licenses are used, that name must be acknowledged. | © Intergovernmental Panel on Climate Change 2014 | +| 13.4.6 | copyrightStatement | A link or path that proves that the source or data has the appropriate license. | https://www.marktstammdatenregister.de/MaStR/Startseite/Impressum | ### License Keys -|#|Key |Description |Example | -|---|---|---|---| -| 13 | **licenses** | An array of objects of the license(s) under which the described package is provided. It can depend on the licenses of the sources (copyleft or share-alike) or can be granted by the creator of the data. | | -| 13.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | -| 13.2 | title | The official (human readable) title of the license. | Open Data Commons Open Database License 1.0 | -| 13.3 | path | A link to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | -| 13.4 | instruction | A short description of rights and restrictions. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information. | -| 13.5 | attribution | The copyright owner of the **data**. If attribution licenses are used, that name must be acknowledged. | © Reiner Lemoine Institut | +| # | Key | Description | Example | +|------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 14 | **licenses** | An array of objects of the license(s) under which the described package is provided. It can depend on the licenses of the sources (copyleft or share-alike) or can be granted by the creator of the data. | | +| 14.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | ODbL-1.0 | +| 14.2 | title | The official (human readable) title of the license. | Open Data Commons Open Database License 1.0 | +| 14.3 | path | A link to the license text. | https://opendatacommons.org/licenses/odbl/1-0/index.html | +| 14.4 | instruction | A short description of rights and restrictions. The use of [tl;drLegal](https://tldrlegal.com/) is recommended. | You are free to share and change, but you must attribute, and share derivations under the same license. See https://tldrlegal.com/license/odc-open-database-license-(odbl) for further information. | +| 14.5 | attribution | The copyright owner of the **data**. If attribution licenses are used, that name must be acknowledged. | © Reiner Lemoine Institut | ### Provenience Keys -|#|Key |Description |Example | -|---|---|---|---| -| 14 | **contributors** | An array of objects of the people or organizations who contributed to the data or metadata. Each object refers to one contributor. Every contributor must have a title and property. The path, email, role and organization properties are optional. | | -| 14.1 | title | A full Name of the contributor. | Ludwig Hülk | -| 14.2 | path | A qualified URL pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID. | https://github.com/Ludee | -| 14.2 | organization | A string describing the organization this contributor is affiliated to. This can be relevant for the copyright. | Reiner Lemoine Institut | -| 14.2 | roles | An array of strings describing the roles of the contributor. A role is RECOMMENDED to follow an established vocabulary, such as DataCite Metadata Schema’s contributorRole or CreDIT. Useful roles to indicate are: creator, contact, and dataCurator. | creator, dataCurator | -| 14.3 | date | The 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 | -| 14.4 | object | The target of the contribution. Which part of the package was supplied or changed. Can be the data, metadata or both (data and metadata). | data and metadata | -| 14.5 | comment | A free text commentary on what has been done. | Updated the description. | +| # | Key | Description | Example | +|------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| 15 | **contributors** | An array of objects of the people or organizations who contributed to the data or metadata. Each object refers to one contributor. Every contributor must have a title and property. The path, email, role and organization properties are optional. | | +| 15.1 | title | A full Name of the contributor. | Ludwig Hülk | +| 15.2 | path | A qualified URL pointing to a relevant location online for the contributor. This can be the GitHub page or ORCID. | https://github.com/Ludee | +| 15.2 | organization | A string describing the organization this contributor is affiliated to. This can be relevant for the copyright. | Reiner Lemoine Institut | +| 15.2 | roles | An array of strings describing the roles of the contributor. A role is RECOMMENDED to follow an established vocabulary, such as DataCite Metadata Schema’s contributorRole or CreDIT. Useful roles to indicate are: creator, contact, and dataCurator. | creator, dataCurator | +| 15.3 | date | The 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 | +| 15.4 | object | The target of the contribution. Which part of the package was supplied or changed. Can be the data, metadata or both (data and metadata). | data and metadata | +| 15.5 | comment | A free text commentary on what has been done. | Updated the description. | ### Resource Keys -|#|Key |Description |Example | -|---|---|---|---| -| 15 | **resources** | An array of objects of the data. It describes the data resource as an individual file or (database) table. | | -| 15.1 | type | A string that indicates that the resource is tabular as per Tabular Data definition. Use "table" for all tables. | table | -| 15.2 | name | A name for the entire data package. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. In a database, this will be the name of the table within the schema containing it. The name can correspond to the file name (minus the file-extension) of the data file describing the resource, if it complies with the naming convention above. Name also contains information about the shema on the OEP, use "." to seperate shema from table name. | openstreetmap.osm_deu_line | -| 15.3 | path | A URL 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_line | -| 15.4 | format | A file extension format. Possible options are 'csv', 'xls', 'json' and other standard file extension for this type of resource. When you upload your data to the OEP, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data is stored in a relational database. | PostgreSQL | -| 15.5 | encoding | Specifies the character encoding of the resource's data file. The values should be one of the ["Preferred MIME Names"](https://www.iana.org/assignments/character-sets/character-sets.xhtml) for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8. | UTF-8 | +| # | Key | Description | Example | +|------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| +| 16 | **resources** | An array of objects of the data. It describes the data resource as an individual file or (database) table. | | +| 16.1 | type | A string that indicates that the resource is tabular as per Tabular Data definition. Use "table" for all tables. | table | +| 16.2 | name | A name for the entire data package. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. In a database, this will be the name of the table within the schema containing it. The name can correspond to the file name (minus the file-extension) of the data file describing the resource, if it complies with the naming convention above. Name also contains information about the shema on the OEP, use "." to seperate shema from table name. | openstreetmap.osm_deu_line | +| 16.3 | path | A URL 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_line | +| 16.4 | format | A file extension format. Possible options are 'csv', 'xls', 'json' and other standard file extension for this type of resource. When you upload your data to the OEP, in the shown metadata string, the format will be changed accordingly to 'PostgreSQL', since the data is stored in a relational database. | PostgreSQL | +| 16.5 | encoding | Specifies the character encoding of the resource's data file. The values should be one of the ["Preferred MIME Names"](https://www.iana.org/assignments/character-sets/character-sets.xhtml) for a character encoding registered with IANA. If no value for this key is specified then the default is UTF-8. | UTF-8 | #### Resource Keys - Schema -|#|Key |Description |Example | -|---|---|---|---| -| 16.6 | **schema** | An object that describes the structure of the present data. It contains all fields (columns of the table), the primary key and optional foreign keys. | | -| 16.6.1 | **fields** | An array of objects describing a column and providing name, description, type and unit. | | -| 16.6.1.1 | name | The name of the field. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. | year | -| 16.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. | -| 16.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | -| 16.6.1.4 | nullable | A boolean key to specify that a column can be nullable. True is the default value. | True | -| 16.6.1.5 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a seperate field, reference this field. | MW | -| 16.6.1.6 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. | -| 16.6.1.6.1 | name | The class label of the OEO terms. | wind energy converting unit | -| 16.6.1.6.2 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000044 | -| 16.6.1.7 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. | | -| 16.6.1.7.1 | value | The name of the value in the column. | onshore | -| 16.6.1.7.2 | name | The class label of the OEO terms. | onshore wind farm | -| 16.6.1.7.3 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 | +| # | Key | Description | Example | +|------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| +| 17.6 | **schema** | An object that describes the structure of the present data. It contains all fields (columns of the table), the primary key and optional foreign keys. | | +| 17.6.1 | **fields** | An array of objects describing a column and providing name, description, type and unit. | | +| 17.6.1.1 | name | The name of the field. The name must consist of only lowercase alphanumeric characters or underscore. It must not start with a number or underscore. | year | +| 17.6.1.2 | description | A text describing the field. | Reference year for which the data were collected. | +| 17.6.1.3 | type | The data type of the field. In case of a geom column in a database, also indicate the shape and CRS. | geometry(Point, 4326) | +| 17.6.1.4 | nullable | A boolean key to specify that a column can be nullable. True is the default value. | True | +| 17.6.1.5 | unit | The unit, preferably SI-unit, that values in this field are mapped to. If 'unit' doesn't apply to a field, use 'null'. If the unit is given in a seperate field, reference this field. | MW | +| 17.6.1.6 | **isAbout** | An array of objects with describe the field in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. | +| 17.6.1.6.1 | name | The class label of the OEO terms. | wind energy converting unit | +| 17.6.1.6.2 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000044 | +| 17.6.1.7 | **valueReference** | An array of objects for an extended description of the values in the column in [OEO](https://openenergy-platform.org/ontology/oeo/) terms. | | +| 17.6.1.7.1 | value | The name of the value in the column. | onshore | +| 17.6.1.7.2 | name | The class label of the OEO terms. | onshore wind farm | +| 17.6.1.7.3 | path | The URI of the class. | https://openenergy-platform.org/ontology/oeo/OEO_00000311 | #### Resource Keys - Properties -|#|Key |Description |Example | -|---|---|---|---| -| 16.6.2 | primaryKey | A primary key is a field or set of fields that uniquely identifies each row in the table. It is recorded as an array, since it is possible to define the primary key as made up of several columns. | id | -| 16.6.3 | **foreignKeys** | A foreign key is a field that refers to a column in another table. | | -| 16.6.3.1 | fields | The column in the table that is constrainted by the foreign key. | version | -| 16.6.3.2 | **reference** | The reference to the foreign table. | | -| 16.6.3.2.1 | resource | The foreign resource (table). | schema.table | -| 16.6.3.2.2 | fields | The foreign resource column. | version | -| 16.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 'null'. | | -| 16.7.1 | delimiter | The delimiter specifies the character sequence which should separate fields (columns). Common characters are "," (comma), "." (point) and "\t" (tab). | , | -| 16.7.2 | decimalSeparator | A 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 ",". | . | +| # | Key | Description | Example | +|------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| 18.6.2 | primaryKey | A primary key is a field or set of fields that uniquely identifies each row in the table. It is recorded as an array, since it is possible to define the primary key as made up of several columns. | id | +| 18.6.3 | **foreignKeys** | A foreign key is a field that refers to a column in another table. | | +| 18.6.3.1 | fields | The column in the table that is constrainted by the foreign key. | version | +| 18.6.3.2 | **reference** | The reference to the foreign table. | | +| 18.6.3.2.1 | resource | The foreign resource (table). | schema.table | +| 18.6.3.2.2 | fields | The foreign resource column. | version | +| 18.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 'null'. | | +| 18.7.1 | delimiter | The delimiter specifies the character sequence which should separate fields (columns). Common characters are "," (comma), "." (point) and "\t" (tab). | , | +| 18.7.2 | decimalSeparator | A 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 ",". | . | ### Review Keys -|#|Key |Description |Example | -|---|---|---|---| -| 16. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/master/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | -| 16.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | -| 16.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | +| # | Key | Description | Example | +|------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| 19. | **review** | Data uploaded through the OEP will go through a review process. The review will cover the data and metadata. It is done by the OEP community. See the [OEP Data Review](https://github.com/OpenEnergyPlatform/data-preprocessing/blob/master/data-review/manual/review_manual.md) for detailed information. The review itself is documented at the specified path and a badge is rewarded with regards to completeness. | | +| 19.1 | path | A URL that should be a permanent http(s) address directly linking to the documented review. | https://www.example.com | +| 19.2 | badge | A badge of either Bronze, Silver, Gold or Platinum is used to label the given data and metadata based on its quality. | Platinum | ### Linked Data Keys -|#|Key |Description |Example | -|---|---|---|---| -| 17 | **linkedData** | Keys used for Linked Data (LD). | | -| 17.1 | @id | A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). | https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07 | -| 17.2 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/master/metadata/latest/context.json | -| 17.3 | user | The unique identifier for the wasGeneratedBy object. | oeplatform | -| 17.4 | @type | The type of the wasGeneratedBy object. | moss:OEMetadataMod | -| 17.5 | usedResource | A reference to the resource used. (ToDo) | ToDo | +| # | Key | Description | Example | +|------|----------------|----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| 20 | **linkedData** | Keys used for Linked Data (LD). | | +| 20.1 | @id | A Uniform Resource Identifier (URI) that links the resource via the OpenEnergyDatabus (DBpedia Databus). | https://databus.openenergyplatform.org/oeplatform/supply/wri_global_power_plant_database/2022-11-07 | +| 20.2 | @context | Explanation of metadata keys in ontology terms. | https://github.com/OpenEnergyPlatform/oemetadata/blob/master/metadata/latest/context.json | +| 20.3 | user | The unique identifier for the wasGeneratedBy object. | oeplatform | +| 20.4 | @type | The type of the wasGeneratedBy object. | moss:OEMetadataMod | +| 20.5 | usedResource | A reference to the resource used. (ToDo) | ToDo | ### MetaMetadata Keys -|#|Key |Description |Example | -|---|---|---|---| -<<<<<<< HEAD -| 18 | **metaMetadata** | An object that describes the metadata themselves, their format, version and license. These fields should already be provided when you are filling out your metadata. | | -| 18.1 | metadataVersion | The type and version number of the metadata. | OEP-1.5.2 | -| 18.2 | **metadataLicense** | The license of the provided metadata. | | -| 18.2.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | CC0-1.0 | -| 18.2.2 | title | The official (human readable) title of the license. | Creative Commons Zero v1.0 Universal | -| 18.2.3 | path | A link to the license text. | https://creativecommons.org/publicdomain/zero/1.0/ | -======= -| 20 | **metaMetadata** | An object that describes the metadata themselves, their format, version and license. These fields should already be provided when you are filling out your metadata. | | -| 20.1 | metadataVersion | The type and version number of the metadata. | OEP-1.5.2 | -| 20.2 | **metadataLicense** | The license of the provided metadata. | | -| 20.2.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | CC0-1.0 | -| 20.2.2 | title | The official (human readable) title of the license. | Creative Commons Zero v1.0 Universal | -| 20.2.3 | path | A link to the license text. | https://creativecommons.org/publicdomain/zero/1.0/ | ->>>>>>> develop +| # | Key | Description | Example | +|--------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| +| 21 | **metaMetadata** | An object that describes the metadata themselves, their format, version and license. These fields should already be provided when you are filling out your metadata. | | +| 21.1 | metadataVersion | The type and version number of the metadata. | OEP-1.5.2 | +| 21.2 | **metadataLicense** | The license of the provided metadata. | | +| 21.2.1 | name | The [SPDX](https://spdx.org/licenses/) identifier. | CC0-1.0 | +| 21.2.2 | title | The official (human-readable) title of the license. | Creative Commons Zero v1.0 Universal | +| 21.2.3 | path | A link to the license text. | https://creativecommons.org/publicdomain/zero/1.0/ | ### Comments -|#|Key |Description |Example | -|---|---|---|---| -<<<<<<< HEAD -| 19 | **_comment** | An array of objects. This section is used as a self-description of the final metadata file. It is text, intended for humans and includes a link to the metadata documentation, required value formats and similar remarks. | | -| 19.1 | metadata | Reference to the metadata documentation in use. | Metadata documentation and explanation (https://github.com/OpenEnergyPlatform/oemetadata) | -| 19.2 | dates | Comment on data and time format. | Dates and time must follow the ISO8601 including time zone (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh) | -| 19.3 | units | Comment on units. | Use a space between numbers and units (100 m) | -| 19.4 | languages | Comment on language format. | Languages must follow the IETF (BCP47) format (en-GB, en-US, de-DE) | -| 19.5 | licenses | Comment on license format. | License name must follow the SPDX License List (https://spdx.org/licenses/) | -| 19.6 | review | Reference to review documentation. | Following the OEP Data Review (https://github.com/OpenEnergyPlatform/data-preprocessing/blob/master/data-review/manual/review_manual.md) | -| 19.7 | null | Comment on fields that don't apply. | If not applicable use: null | -| 19.8 | todo | Comment on fields that are not yet available and will be inserted later on. | If a value is not yet available, use: todo | -======= -| 21 | **_comment** | An array of objects. This section is used as a self-description of the final metadata file. It is text, intended for humans and includes a link to the metadata documentation, required value formats and similar remarks. | | -| 21.1 | metadata | Reference to the metadata documentation in use. | Metadata documentation and explanation (https://github.com/OpenEnergyPlatform/oemetadata) | -| 21.2 | dates | Comment on data and time format. | Dates and time must follow the ISO8601 including time zone (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh) | -| 21.3 | units | Comment on units. | Use a space between numbers and units (100 m) | -| 21.4 | languages | Comment on language format. | Languages must follow the IETF (BCP47) format (en-GB, en-US, de-DE) | -| 21.5 | licenses | Comment on license format. | License name must follow the SPDX License List (https://spdx.org/licenses/) | -| 21.6 | review | Reference to review documentation. | Following the OEP Data Review (https://github.com/OpenEnergyPlatform/data-preprocessing/blob/master/data-review/manual/review_manual.md) | -| 21.7 | null | Comment on fields that don't apply. | If not applicable use: null | -| 21.8 | todo | Comment on fields that are not yet available and will be inserted later on. | If a value is not yet available, use: todo | ->>>>>>> develop +| # | Key | Description | Example | +|------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| 22 | **_comment** | An array of objects. This section is used as a self-description of the final metadata file. It is text, intended for humans and includes a link to the metadata documentation, required value formats and similar remarks. | | +| 22.1 | metadata | Reference to the metadata documentation in use. | Metadata documentation and explanation (https://github.com/OpenEnergyPlatform/oemetadata) | +| 22.2 | dates | Comment on data and time format. | Dates and time must follow the ISO8601 including time zone (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh) | +| 22.3 | units | Comment on units. | Use a space between numbers and units (100 m) | +| 22.4 | languages | Comment on language format. | Languages must follow the IETF (BCP47) format (en-GB, en-US, de-DE) | +| 22.5 | licenses | Comment on license format. | License name must follow the SPDX License List (https://spdx.org/licenses/) | +| 22.6 | review | Reference to review documentation. | Following the OEP Data Review (https://github.com/OpenEnergyPlatform/data-preprocessing/blob/master/data-review/manual/review_manual.md) | +| 22.7 | null | Comment on fields that don't apply. | If not applicable use: null | +| 22.8 | todo | Comment on fields that are not yet available and will be inserted later on. | If a value is not yet available, use: todo |