Explanation of metadata keys in ontology terms for key 1
Metadata keys must be matched with ontology terms to address key OpenEnergyPlatform/oemetadata#1 @context.
The table below is the first proposal of suitable terms.
Existing resources:
- https://github.com/OpenEnergyPlatform/oemetadata/issues/25
- https://github.com/LOD-GEOSS/databus-snippets/blob/master/oep_metadata/context.jsonld
The table shows the v1.5.0 keys.
| # | key | ontology_id | related_ontology_id | missing |
|---|---|---|---|---|
| 1 | @context |
link to this sheet itself | ||
| 2 | name | 'written name' http://purl.obolibrary.org/obo/IAO_0000590 | ||
| 3 | title | dc:title | ||
| 4 | id | dc:indentifier | ||
| 5 | @id |
link, resource, databus | ||
| 5 | description | dc:description | resource | |
| 7 | language | dc:language | ||
| 8 | subject | 'is about' http://purl.obolibrary.org/obo/IAO_0000136 | ||
| 9 | keywords | keyword | ||
| 10 | publicationDate | dc:date | ||
| 11 | context | database http://openenergy-platform.org/ontology/oeo/OEO_00000118 project http://openenergy-platform.org/ontology/oeo/OEO_00000340 |
context, environment, general setting | |
| 11.1 | homepage | foaf:homepage | link | |
| 11.2 | documentation | link | ||
| 11.3 | sourceCode | 'code source' http://openenergy-platform.org/ontology/oeo/OEO_00000091 | link | |
| 11.4 | contact | 'email address' http://openenergy-platform.org/ontology/oeo/OEO_00140171 | ||
| 11.5 | grantNo | 'has funding source' http://openenergy-platform.org/ontology/oeo/OEO_00000509 'has number' http://openenergy-platform.org/ontology/oeo/OEO_00140178 |
||
| 11.6 | fundingAgency | 'has funding source' http://openenergy-platform.org/ontology/oeo/OEO_00000509 institution http://openenergy-platform.org/ontology/oeo/OEO_00000238 |
||
| 11.7 | fundingAgencyLogo | 'has funding source' http://openenergy-platform.org/ontology/oeo/OEO_00000509 institution http://openenergy-platform.org/ontology/oeo/OEO_00000238 |
logo | |
| 11.8 | publisherLogo | dc:publisher | logo | |
| 12 | spatial | |||
| 12.1 | location | 'geographic coordinate' http://openenergy-platform.org/ontology/oeo/OEO_00000189 | ||
| 12.2 | extent | 'spatial region' http://purl.obolibrary.org/obo/BFO_0000006 | ||
| 12.3 | resolution | 'spatial resolution' http://openenergy-platform.org/ontology/oeo/OEO_00020123 | ||
| 13 | temporal | |||
| 13.1 | referenceDate | dc:date | ||
| 13.2 | timeseries | 'time series' http://openenergy-platform.org/ontology/oeo/OEO_00030034 | ||
| 13.2.1 | start | 'start time' http://openenergy-platform.org/ontology/oeo/OEO_00030031 'time series' http://openenergy-platform.org/ontology/oeo/OEO_00030034 |
||
| 13.2.2 | end | 'ending time' http://openenergy-platform.org/ontology/oeo/OEO_00030032 'time series' http://openenergy-platform.org/ontology/oeo/OEO_00030034 |
||
| 13.2.3 | resolution | 'temporal resolution' http://openenergy-platform.org/ontology/oeo/OEO_00020122 'time series' http://openenergy-platform.org/ontology/oeo/OEO_00030034 |
||
| 13.2.4 | alignment | 'start alignment' http://openenergy-platform.org/ontology/oeo/OEO_00140045 'time series' http://openenergy-platform.org/ontology/oeo/OEO_00030034 |
||
| 13.2.5 | aggregationType | 'aggregation type' http://openenergy-platform.org/ontology/oeo/OEO_00140068 'time series' http://openenergy-platform.org/ontology/oeo/OEO_00030034 |
||
| 14 | sources | dc:source | ||
| 14.1 | title | dc:title dc:source |
||
| 14.2 | description | dc:description dc:source |
||
| 14.3 | path | dc:source | link | |
| 14.4 | licenses | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:source |
||
| 14.4.1 | name | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 'written name' http://purl.obolibrary.org/obo/IAO_0000590 dc:source |
||
| 14.4.2 | title | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:title dc:source |
||
| 14.4.3 | path | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:source |
link | |
| 14.4.4 | instruction | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:rights dc:source |
||
| 14.4.5 | attribution | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:source |
attribution | |
| 15 | licenses | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:publisher |
||
| 15.1 | name | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:publisher 'written name' http://purl.obolibrary.org/obo/IAO_0000590 |
||
| 15.2 | title | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:publisher dc:title |
||
| 15.3 | path | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:publisher |
link | |
| 15.4 | instruction | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:publisher dc:rights |
||
| 15.5 | attribution | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 dc:publisher |
attribution | |
| 16 | contributors | dc:contributor | ||
| 16.1 | title | dc:contributor dc:title |
||
| 16.2 | dc:contributor 'email address' http://openenergy-platform.org/ontology/oeo/OEO_00140171 |
|||
| 16.3 | date | dc:contributor dc:date |
||
| 16.4 | object | dc:contributor |
object that metadata is for | |
| 16.5 | comment | dc:contributor dc:description |
||
| 17 | resources | 'data item' http://purl.obolibrary.org/obo/IAO_0000027 | column, resource | |
| 17.1 | profile | 'written name' http://purl.obolibrary.org/obo/IAO_0000590 | ||
| 17.2 | name | |||
| 17.3 | path | dc:source | ||
| 17.4 | format | dc:format | ||
| 17.5 | encoding | encoding | ||
| 17.6 | schema | schema | ||
| 17.6.1 | fields | fields / columns | ||
| 17.6.1.1 | name | 'written name' http://purl.obolibrary.org/obo/IAO_0000590 | ||
| 17.6.1.2 | description | dc:description | ||
| 17.6.1.3 | type | dc:type | ||
| 17.6.1.4 | is_about | link, ontology_identifier | ||
| 17.6.1.5 | value_reference | link, ontology_identifier (row-wise) | ||
| 17.6.1.6 | unit | 'is unit of' http://purl.obolibrary.org/obo/uo#is_unit_of 'has unit' http://openenergy-platform.org/ontology/oeo/OEO_00040010 |
||
| 17.6.2 | primaryKey | primaryKey | ||
| 17.6.3 | foreignKeys | foreignKeys | ||
| 17.6.3.1 | fields | fields | ||
| 17.6.3.2 | reference | dc:identifier | link | |
| 17.6.3.2.1 | resource | resource | ||
| 17.6.3.2.2 | fields | fields / columns | ||
| 17.7 | dialect | dialect | ||
| 17.7.1 | delimiter | delimiter | ||
| 17.7.2 | decimalSeparator | decimalSeparator | ||
| 18. | review | |||
| 18.1 | path | link | ||
| 18.2 | badge | 'quality control flag' http://openenergy-platform.org/ontology/oeo/OEO_00140098 'has quality' http://purl.obolibrary.org/obo/RO_0000086 quality http://purl.obolibrary.org/obo/BFO_0000019 |
||
| 19 | metaMetadata | metaMetadata | ||
| 19.1 | metadataVersion | metadata, version | ||
| 19.2 | metadataLicense | licence http://openenergy-platform.org/ontology/oeo/OEO_00020015 | metadata | |
| 19.2.1 | name | 'written name' http://purl.obolibrary.org/obo/IAO_0000590 | ||
| 19.2.2 | title | dc:title | ||
| 19.2.3 | path | link | ||
| 20 | _comment | dc:description | ||
| 20.1 | metadata | |||
| 20.2 | dates | |||
| 20.3 | units | |||
| 20.4 | languages | |||
| 20.5 | licenses | |||
| 20.6 | review | |||
| 20.7 | null | |||
| 20.8 | todo | |||
| 20.9 | ... |
Some terms are not covered by the OEO yet. In metadata V1.4, the DCAT is used for these terms. I will use the OEO as much as possible.
@adelmemariani can you collect the missing terms and open an issue in the OEO repo please? We should add the missing terms soon.
Hej @adelmemariani, I've updated the table above with suggestions to apply the OEO as best as possible to the metadata (I noticed I still had them locally). However, I was unsure whether to only describe the metadata keys with classes or if object properties are also allowed in my attempt. In doubt, I linked both if they seemed related.
I'll continue and start the implementation of missing OEO concepts for oemetadata keys in the OEO repo.
I'm not sure if this is related, but I want to mention it: OMI has already implemented some functionality related to RDF based on the oemetadata (v1.4.1 so far). There is an example .ttl file.
I just found this https://nfdi4ing.pages.rwth-aachen.de/metadata4ing/metadata4ing/
From 04.05.23 dev-meeting: Don't use composed terms but add new terms to OEO @chrwm proposes new concepts here
It is probably better to open small issues for needed composed concepts.
Some comments:
| # | key | ontology_id | related_ontology_id | missing |
|---|---|---|---|---|
| 11.3 | sourceCode | 'code source' http://openenergy-platform.org/ontology/oeo/OEO_00000091 | link |
A code source is something different than a source code: A code source is a data descriptor describing the origin of some code.
| # | key | ontology_id | related_ontology_id | missing |
|---|---|---|---|---|
| 11.5 | grantNo | 'has funding source' http://openenergy-platform.org/ontology/oeo/OEO_00000509 'has number' http://openenergy-platform.org/ontology/oeo/OEO_00140178 |
The data property has number is a property of a quantity value: Has number is a data property that links a quantity value to a number that defines the quantity value. But a grant number like 03EI1035[^1] is not a quantity value, similarly as a post code like 12345 is not a quantity value either.
[^1]: This is the grant number of the SIROP project
| # | key | ontology_id | related_ontology_id | missing |
|---|---|---|---|---|
| 17.6.1.6 | unit | 'is unit of' http://purl.obolibrary.org/obo/uo#is_unit_of 'has unit' http://openenergy-platform.org/ontology/oeo/OEO_00040010 |
The right OEO class here should be unit of measurement: A unit of measurement is a standardised quantity of a quantifiable entity.
A general question: Do we map the OEMetadata keys on either classes or object properties or both? Are there opinions from the OEKG team regarding the technical relevance?
Good question. For the mapping, we'd need both. Some entries might be related with a simple is about, but I guess, this does not fit for the majority. A good place to look is the Relations Ontology RO.
For the OEKG, we create some special "object properties" that are not included in OEO. The mapping will be part of OEKG, too, right? @adelmemariani
@Ludee is this issue still relevant with OEMetadata 2.0?
I think we overlooked this 🙃 We could use the OEO terms linked above. For now, the JSONLD mapping covers most properties with external terms. We aimed to match every key to something appropriate. Actually, some properties are match to a medical ontology. I think creating something well-defined for our use case should help to understand the purpose. In the end, we would need to create our own types defining the oemetadata in RDF using SHACL and OEO terms to actually match the meaning of the oemetadata properties.
For now the json ld will serve current needs in order to integrate the MOSS (Metadata Overlay Search Service) and enable nice semantic search across the database including metadata. Later this also enables SPARQL queries returning tables from our database.
OK, so we don't close this issue?!
Im not 100% sure. Information here is relevant but only parts of it and the general goal of this issue is solved with oemetadata v2. Maybe closing this one, create a new issue in the oemetadata repo and link this issue there for reference is better / makes things more clear. Since we restructured the oemetadata in v2 the structure of the table above does not match anymore and some keys are renamed / added. Once we identified all terms that are not available in the OEO we can create specific issues here.
I'll transfer this issue to the oemetadata repo, then you can work on this and it doesn't get lost here... If you need smth from OEO side, feel free to open a new issue!