pds-data-dictionaries / PDS4-LDD-Issue-Repo

Issue repository for tracking all PDS4 Discipline Dictionary-related issues, new feature requests, and releases.
Apache License 2.0
2 stars 1 forks source link

[ldd-ml] Address DMSP suggestions #232

Closed wkiri closed 2 years ago

wkiri commented 2 years ago

Describe the issue identified Address suggestions from DMSP review of this sub-model.

Describe the solution you'd like

Describe alternatives you've considered None

LDD Dictionary Version 1.0.1.0

PDS4 IM Version 1.18.0.0

Need-by Date When possible.

Additional context DMSP workshop follow-up.

wkiri commented 2 years ago

I've addressed all of the suggestions except the one to add a data_set_name attribute to the Data_Set class. Not all data sets have a designated name, so this might be hard to fill in. However, for provenance, it is worth thinking of a way to include a data_set_source (DOI?) which would give the option for a direct link to the original data set.

jordanpadams commented 2 years ago

@wkiri You could maybe leave this somewhat "open ended" and have a choice for how they want to reference the data set amongst a few options. Here are some that come to mind, but others may have some ideas:

Not sure if these would be considered "source products" or not, but here are some others:

wkiri commented 2 years ago

@jordanpadams Thanks! Yes, I think a pds.external_reference would be great. We use that for a DOI for the machine learning algorithm specification (when documented with a paper); see below. I think a DOI for the data set(s) likewise formatted would be a good addition.

https://github.com/pds-data-dictionaries/ldd-ml/blob/c13e6ca92c9bfc18b42778ad2f7bb06e9e17b67e/src/PDS4_ML_IngestLDD.xml#L388-L394