Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 0.3.0 for specimen and media #94

Merged
merged 12 commits into from
Jun 7, 2024
Merged

Conversation

samleeflang
Copy link
Contributor

@samleeflang samleeflang commented May 28, 2024

Hopefully the last changes before we move to production.
All terms should now be connected to an ontology (mostly ods: and dwc: some dcterms: or others).

ODS Prefix

ODS prefix for all terms which still weren't assigned to a ontology.

Updated arrays to be plural

We decided to update the arrays to be plural, in line with recommendated practices.
This means that where Darwin Core Classes where available we wrapped this by an ods term with the plural.
For example, dwc:Identification becomes wrapped in ods:Identifications which now contains zero or more instances of dwc:Identification.
The tradeoff is that we added an additional layer of nesting, but we believe this is worth it to keep the terms in line with the Darwin Core standard.

Other

Small changes in description for some terms.
dwc:institutionName is not a Darwin Core term, converted to ods:institutionName.

https://naturalis.atlassian.net/browse/DD-1165
https://naturalis.atlassian.net/browse/DD-1186

Copy link
Contributor

@sharifX sharifX left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes look ok. we discussed via slack.

Copy link
Contributor

@southeo southeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

several comments, but quite a few are me fixing regexes that i think I wrote 😅

I think it would be helpful to have example jsons so you can validate these schemas against something. i know it's more work but a lot of them can be copied from 0.1

data-model/fdo-types/0.3.0/RELEASE_NOTES.md Show resolved Hide resolved
"ods:type": {
"type": "string",
"description": "The FDO type of the object",
"$comment": "Unclear what value goes here"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove/update comment, this should be a Handle or DOI

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@samleeflang
Copy link
Contributor Author

Yes will add some examples. Will use a couple of specimens from test (in the current format) and then change them so they comply to this version

"dwc:datasetName": "Naturalis Biodiversity Center (NL) - Aves",
"dcterms:rightsHolder": "Naturalis Biodiversity Center",
"ods:MaterialEntities": [],
"ods:Identifications": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok so instead of having the dwc:identification, etc. as an array we now have the ods variant as the array.
Guess this makes sense because now all of the dwc elements are objects

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changed a bit to ods:hasIdentification : [{}]

Copy link
Contributor

@southeo southeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mamma mia 🍝

I think we're at the point where this could conceivably be a 1.0 release, especially if we're planning to go to production with this. What do you think?

data-model/Dockerfile Outdated Show resolved Hide resolved
},
"ods:isBarcodeOrNFC": {
"type": "boolean",
"description": "Part of barcode or nfc chip"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit confusing. See:
"Do you want coffee or tea?"
"yes"

you think it's asking (A or B), but it's really asking is it "(A or B), or is it anything else?"

Can you split these into 2 terms, isPartOfBarcode, isPartOfNfcChip?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or make the field optional with a string value that can either be barcode or nfc via an enum

data-model/fdo-types/0.3.0/RELEASE_NOTES.md Outdated Show resolved Hide resolved
data-model/fdo-types/0.3.0/RELEASE_NOTES.md Show resolved Hide resolved
"ods:hasCitation": [
{}
],
"ods:hasIdentifier": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should 'ods:normalisedPhysicalSpecimenID' be in this list as well?


{
      "@type": "ods:Identifier",
      "ods:identifierType": "ods:normalisedPhysicalSpecimenID",
      "ods:identifierValue": "https://data.biodiversitydata.nl/naturalis/specimen/RMNH.AVES.121559"
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we can include these but that doesn't change the data model right? It would just be one more identifier in the hasIdentifier part

Copy link
Contributor

@TomDijkema TomDijkema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DiSSCo Threeie

},
"ods:isBarcodeOrNFC": {
"type": "boolean",
"description": "Part of barcode or nfc chip"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or make the field optional with a string value that can either be barcode or nfc via an enum

Copy link
Contributor

@southeo southeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're almost there!!

@samleeflang samleeflang merged commit 5cb29cf into master Jun 7, 2024
1 check passed
@samleeflang samleeflang deleted the feature/specimen-0.3.0 branch June 7, 2024 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants