Merge pull request #94 from psychoinformatics-de/ex-rocrate

Add RO-crate inspired examples
psychoinformatics-de · Mar 10, 2024 · 6f02fc6 · 6f02fc6
2 parents b26ae9f + e8429dc
commit 6f02fc6
Show file tree

Hide file tree

Showing 15 changed files with 376 additions and 186 deletions.
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -21,3 +21,5 @@ jobs:
         uses: actions/checkout@v4
       - name: Codespell
         uses: codespell-project/actions-codespell@v2
+        with:
+          ignore_words_list: crate
diff --git a/src/examples/dataset-version/DatasetVersionObject-affiliation.json b/src/examples/dataset-version/DatasetVersionObject-affiliation.json
@@ -1,22 +1,27 @@
 {
+  "was_attributed_to": [
+    {
+      "meta_code": "doe",
+      "meta_type": "dlco:ResearchContributorObject",
+      "name": "Jane Doe",
+      "email": "doe@example.com",
+      "affiliation": "DFG"
+    },
+    {
+      "meta_code": "DFG",
+      "meta_type": "dlco:OrganizationObject",
+      "name": "Deutsche Forschungsgemeinschaft"
+    }
+  ],
   "qualified_attribution": [
     {
-      "agent": {
-        "meta_type": "dlco:ResearchContributorObject",
-        "name": "Jane Doe",
-        "email": "doe@example.com",
-        "affiliation": "DFG"
-      },
+      "agent": "doe",
       "had_role": [
         "marcrel:aut"
       ]
     },
     {
-      "agent": {
-        "meta_type": "dlco:OrganizationObject",
-        "name": "Deutsche Forschungsgemeinschaft",
-        "meta_code": "DFG"
-      },
+      "agent": "DFG",
       "had_role": [
         "marcrel:sht"
       ]

diff --git a/src/examples/dataset-version/DatasetVersionObject-affiliation.yaml b/src/examples/dataset-version/DatasetVersionObject-affiliation.yaml
@@ -1,18 +1,20 @@
 description: >-
   Some key facts about the data
+was_attributed_to:
+  - meta_type: dlco:ResearchContributorObject
+    meta_code: doe
+    name: Jane Doe
+    email: doe@example.com
+    # reference organization by meta_code
+    affiliation: DFG
+  - meta_type: dlco:OrganizationObject
+    meta_code: DFG
+    name: Deutsche Forschungsgemeinschaft
 qualified_attribution:
-  - agent:
-      meta_type: dlco:ResearchContributorObject
-      name: Jane Doe
-      email: doe@example.com
-      # reference organization by meta_code
-      affiliation: DFG
+  - agent: doe
     had_role:
       - marcrel:aut
-  - agent:
-      meta_type: dlco:OrganizationObject
-      meta_code: DFG
-      name: Deutsche Forschungsgemeinschaft
+  - agent: DFG
     had_role:
       # Supporting host
       - marcrel:sht
diff --git a/src/examples/dataset-version/DatasetVersionObject-funding.json b/src/examples/dataset-version/DatasetVersionObject-funding.json
@@ -1,19 +1,23 @@
 {
   "qualified_relation": [
     {
-      "entity": {
-        "meta_type": "dlco:GrantObject",
-        "identifier": "https://gepris.dfg.de/gepris/projekt/431549029",
-        "sponsor": {
-          "name": "Deutsche Forschungsgemeinschaft"
-        },
-        "name": "SFB1451"
-      },
+      "entity": "sfb1451",
       "had_role": [
         "schema:funding"
       ]
     }
   ],
+  "relation": [
+    {
+      "meta_code": "sfb1451",
+      "meta_type": "dlco:GrantObject",
+      "identifier": "https://gepris.dfg.de/gepris/projekt/431549029",
+      "sponsor": {
+        "name": "Deutsche Forschungsgemeinschaft"
+      },
+      "name": "SFB1451"
+    }
+  ],
   "description": "Some key facts about the data",
   "@type": "DatasetVersionObject"
 }
diff --git a/src/examples/dataset-version/DatasetVersionObject-funding.yaml b/src/examples/dataset-version/DatasetVersionObject-funding.yaml
@@ -1,11 +1,13 @@
 description: >-
   Some key facts about the data
+relation:
+  - meta_type: dlco:GrantObject
+    meta_code: sfb1451
+    name: SFB1451
+    identifier: https://gepris.dfg.de/gepris/projekt/431549029
+    sponsor:
+      name: Deutsche Forschungsgemeinschaft
 qualified_relation:
-  - entity:
-      meta_type: dlco:GrantObject
-      name: SFB1451
-      identifier: https://gepris.dfg.de/gepris/projekt/431549029
-      sponsor:
-        name: Deutsche Forschungsgemeinschaft
+  - entity: sfb1451
     had_role:
       - schema:funding
diff --git a/src/examples/dataset-version/DatasetVersionObject-penguins.json b/src/examples/dataset-version/DatasetVersionObject-penguins.json
@@ -63,131 +63,152 @@
   "identifier": [
     "https://doi.org/10.5281/zenodo.3960218"
   ],
+  "was_attributed_to": [
+    {
+      "meta_code": "ahorst",
+      "meta_type": "dlco:ResearchContributorObject",
+      "name": "Allison Horst",
+      "email": "ahorst@example.com",
+      "affiliation": "UCSB",
+      "orcid": "0000-0002-6047-5564"
+    },
+    {
+      "meta_code": "ahill",
+      "meta_type": "dlco:ResearchContributorObject",
+      "name": "Allison Hill",
+      "email": "ahill@example.com",
+      "affiliation": "Rstudio",
+      "orcid": "0000-0002-8082-1890"
+    },
+    {
+      "meta_code": "kgorman",
+      "meta_type": "dlco:ResearchContributorObject",
+      "name": "Kirsten Gorman",
+      "email": "kgorman@example.com",
+      "affiliation": "UAF",
+      "orcid": "0000-0002-0258-9264"
+    },
+    {
+      "meta_code": "UCSB",
+      "meta_type": "dlco:OrganizationObject",
+      "name": "UC Santa Barbara: Santa Barbara, CA, US"
+    },
+    {
+      "meta_code": "RStudio",
+      "meta_type": "dlco:OrganizationObject",
+      "name": "RStudio: Boston, MA, US"
+    },
+    {
+      "meta_code": "UAF",
+      "meta_type": "dlco:OrganizationObject",
+      "name": "University of Alaska Fairbanks: Fairbanks, AK, US"
+    }
+  ],
   "qualified_attribution": [
     {
-      "agent": {
-        "meta_type": "dlco:ResearchContributorObject",
-        "name": "Allison Horst",
-        "email": "ahorst@example.com",
-        "affiliation": "UCSB",
-        "orcid": "0000-0002-6047-5564"
-      },
+      "agent": "ahorst",
       "had_role": [
         "marcrel:aut",
         "dpv:DataController"
       ]
     },
     {
-      "agent": {
-        "meta_type": "dlco:ResearchContributorObject",
-        "name": "Allison Hill",
-        "email": "ahill@example.com",
-        "affiliation": "Rstudio",
-        "orcid": "0000-0002-8082-1890"
-      },
+      "agent": "ahill",
       "had_role": [
         "marcrel:aut"
       ]
     },
     {
-      "agent": {
-        "meta_type": "dlco:ResearchContributorObject",
-        "name": "Kirsten Gorman",
-        "email": "kgorman@example.com",
-        "affiliation": "UAF",
-        "orcid": "0000-0002-0258-9264"
-      },
+      "agent": "kgorman",
       "had_role": [
         "marcrel:aut",
         "marcrel:cre"
       ]
     },
     {
-      "agent": {
-        "meta_type": "dlco:OrganizationObject",
-        "name": "UC Santa Barbara: Santa Barbara, CA, US",
-        "meta_code": "UCSB"
-      },
+      "agent": "UCSB",
       "had_role": [
         "marcrel:sht"
       ]
     },
     {
-      "agent": {
-        "meta_type": "dlco:OrganizationObject",
-        "name": "RStudio: Boston, MA, US",
-        "meta_code": "RStudio"
-      },
+      "agent": "RStudio",
       "had_role": [
         "marcrel:sht"
       ]
     },
     {
-      "agent": {
-        "meta_type": "dlco:OrganizationObject",
-        "name": "University of Alaska Fairbanks: Fairbanks, AK, US",
-        "meta_code": "UAF"
-      },
+      "agent": "UAF",
       "had_role": [
         "marcrel:sht"
       ]
     }
   ],
   "qualified_relation": [
     {
-      "entity": {
-        "meta_type": "dlco:GrantObject",
-        "identifier": "0217282",
-        "sponsor": {
-          "name": "NSF Office of Polar Programs"
-        },
-        "name": "LTER: PALMER, ANTARCTICA LTER: Climate Change, Ecosystem Migration and Teleconnections in an Ice-Dominated Environment",
-        "cites_as_authority": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0217282&HistoricalAwards=false"
-      },
+      "entity": "nsf0217282",
       "had_role": [
         "schema:funding"
       ]
     },
     {
-      "entity": {
-        "meta_type": "dlco:GrantObject",
-        "identifier": "0823101",
-        "sponsor": {
-          "name": "NSF Office of Polar Programs"
-        },
-        "name": "Palmer, Antarctica Long Term Ecological Research Project",
-        "cites_as_authority": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0823101"
-      },
+      "entity": "nsf0823101",
       "had_role": [
         "schema:funding"
       ]
     },
     {
-      "entity": {
-        "meta_type": "dlco:GrantObject",
-        "identifier": "0741351",
-        "sponsor": {
-          "name": "NSF Office of Polar Programs"
-        },
-        "name": "Collaborative Research: Possible Climate-induced Change in the Distribution of Pleuragramma Antarcticum on the Western Antarctic Peninsula Shelf",
-        "cites_as_authority": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0741351"
-      },
+      "entity": "nsf0741351",
       "had_role": [
         "schema:funding"
       ]
     },
     {
-      "entity": {
-        "meta_type": "dlco:PublicationObject",
-        "citation": "'Gorman KB, Williams TD, Fraser WR (2014) Ecological Sexual Dimorphism and Environmental Variability within a Community of Antarctic Penguins (Genus Pygoscelis). PLoS ONE 9(3): e90081.'",
-        "doi": "https://doi.org/10.1371/journal.pone.0090081"
-      },
+      "entity": "gormanetal",
       "had_role": [
         "CiTO:citesAsAuthority",
         "CiTO:isCitedAsDataSourceBy"
       ]
     }
   ],
+  "relation": [
+    {
+      "meta_code": "nsf0217282",
+      "meta_type": "dlco:GrantObject",
+      "identifier": "0217282",
+      "sponsor": {
+        "name": "NSF Office of Polar Programs"
+      },
+      "name": "LTER: PALMER, ANTARCTICA LTER: Climate Change, Ecosystem Migration and Teleconnections in an Ice-Dominated Environment",
+      "cites_as_authority": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0217282&HistoricalAwards=false"
+    },
+    {
+      "meta_code": "nsf0823101",
+      "meta_type": "dlco:GrantObject",
+      "identifier": "0823101",
+      "sponsor": {
+        "name": "NSF Office of Polar Programs"
+      },
+      "name": "Palmer, Antarctica Long Term Ecological Research Project",
+      "cites_as_authority": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0823101"
+    },
+    {
+      "meta_code": "nsf0741351",
+      "meta_type": "dlco:GrantObject",
+      "identifier": "0741351",
+      "sponsor": {
+        "name": "NSF Office of Polar Programs"
+      },
+      "name": "Collaborative Research: Possible Climate-induced Change in the Distribution of Pleuragramma Antarcticum on the Western Antarctic Peninsula Shelf",
+      "cites_as_authority": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0741351"
+    },
+    {
+      "meta_code": "gormanetal",
+      "meta_type": "dlco:PublicationObject",
+      "citation": "'Gorman KB, Williams TD, Fraser WR (2014) Ecological Sexual Dimorphism and Environmental Variability within a Community of Antarctic Penguins (Genus Pygoscelis). PLoS ONE 9(3): e90081.'",
+      "doi": "https://doi.org/10.1371/journal.pone.0090081"
+    }
+  ],
   "description": "The goal of palmerpenguins is to provide a great dataset for data exploration and visualization, as an alternative to iris. Data were collected and made available by Dr. Kristen Gorman and the Palmer Station, Antarctica LTER, a member of the Long Term Ecological Research Network.",
   "keyword": [
     "penguins",