OpenEnergyPlatform / oemetadata

Repository for the Open Energy Family metadata. Contains metadata templates, examples and schemas. For metadata conversion see https://github.com/OpenEnergyPlatform/omi
https://openenergyplatform.github.io/oemetadata/
MIT License
21 stars 3 forks source link

Add instructions on usage of None, "none" and "" #54

Closed nesnoj closed 2 years ago

nesnoj commented 2 years ago

For some fields of the current meta description there're hints what value to use if a value is empty or does not apply but most fields lack this information. In which cases do I use None (translated to null in json), "none" and ""?

There has been a discussion in eGon-data but to my mind the instructions are somewhat ambiguous. This should be discussed further and translated into clear, unambiguous instructions.

chrwm commented 2 years ago

Summary of implementation logic as of v1.5

  1. keys without an applicable value: null For keys without an applicable value, please enter null. This is the standard value and means that a key is not used.

  2. keys with an applicable value that isn't yet available and will be added in the future: "todo" For keys with an applicable value that isn't yet available, please enter "todo". This is a placeholder for a value you will insert later.

You mustn't use any of these inputs to indicate case 1 or 2 above:

nesnoj commented 2 years ago

Thanks for the clarification @chrwm! So if I got this right, from v1.5.0 on there will be no distinction between "this key does not apply" (e.g. spatial resolution for a timeseries) or "no information on this key" (e.g. I don't know) ?

chrwm commented 2 years ago

So if I got this right, from v1.5.0 on, there will be no distinction between "this key does not apply" (e.g. spatial resolution for a timeseries)

In my understanding, this would describe case 1 above. Therefore, null would apply.

"no information on this key" (e.g. I don't know)

I understand your second case as follows: You know that the key is suitable for describing the artefact, but you don't know or don't yet know the value. In this case, I would enter "todo" regardless of the chances of finding the value and adding it. This signals that the key is fit to describe the artefact, but the value is not or not yet entered. Did I understand you correctly?

nesnoj commented 2 years ago

I understand your second case as follows: You know that the key is suitable for describing the artefact, but you don't know or don't yet know the value. In this case, I would enter "todo" regardless of the chances of finding the value and adding it. This signals that the key is fit to describe the artefact, but the value is not or not yet entered. Did I understand you correctly?

Ok, got it. Thanks.