Skip to content

Commit

Permalink
Adds research-dataset-schema and testing data
Browse files Browse the repository at this point in the history
This adds a new schema that aims to model a generic research dataset.
A (supposedly) valid json data document is added, as well as an invalid
document, for testing purposes. The makefile is updated to add testing
and document / output generation for the new schema.
  • Loading branch information
jsheunis committed Dec 19, 2023
1 parent 89bdaf8 commit 87244ec
Show file tree
Hide file tree
Showing 5 changed files with 462 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ build/context.jsonld: src/linkml/ontology.yaml
--mergeimports \
$< > $@

build/linkml-docs: build/linkml-docs/ontology build/linkml-docs/data-access-schema
build/linkml-docs: build/linkml-docs/ontology build/linkml-docs/data-access-schema \
build/linkml-docs/research-dataset-schema
build/linkml-docs/%: src/linkml/%.yaml src/extra-docs/%
gen-doc \
--mergeimports \
Expand All @@ -45,7 +46,8 @@ build/mkdocs-site: build/linkml-docs src/extra-docs/*.md
# add additional schemas to lint here
check: \
check-data-access-schema \
check-ontology
check-ontology \
check-research-dataset-schema
check-%: src/linkml/%.yaml
@echo [Check $<]
@echo "Run linter"
Expand Down Expand Up @@ -75,7 +77,8 @@ check-%: src/linkml/%.yaml
# naming schema <class>-<example-name>.yaml to be
# usable as documentation examples for `gen-doc`
validate-examples: \
validate-examples-data-access-schema
validate-examples-data-access-schema \
validate-examples-research-dataset-schema
validate-examples-%:
$(MAKE) validate-valid-examples-$* validate-invalid-examples-$*
validate-valid-examples-%: src/linkml/%.yaml src/examples/%
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"license": "https://creativecommons.org/publicdomain/zero/1.0/",
"homepage": "https://github.com/allisonhorst/palmerpenguins",
"title": "Palmer Penguins"
}
97 changes: 97 additions & 0 deletions src/examples/research-dataset-schema/ResearchDataset-penguins.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
{
"license": "https://creativecommons.org/publicdomain/zero/1.0/",
"homepage": "https://github.com/allisonhorst/palmerpenguins",
"name": "penguins",
"title": "Palmer Penguins",
"doi": "https://doi.org/10.5281/zenodo.3960218",
"version": "0.1.0",
"date_modified": "2020-07-16",
"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.",
"data_controller": {
"email": "[email protected]",
"name": "Allison Horst"
},
"keywords": [
"penguins",
"sea ice",
"foraging",
"ecological niches",
"islands",
"antarctica",
"animal sexual behavior",
"isotopes"
],
"has_part": [
{
"checksum_md5": "e7e2be6b203a221949f05e02fcefd853",
"content_url": "https://portal.edirepository.org/nis/dataviewer?packageid=knb-lter-pal.219.3&entityid=002f3893385f710df69eeebe893144ff",
"path_posix": "raw/adelie.csv",
"size_in_bytes": 23755
},
{
"checksum_md5": "1549566fb97afa879dc9446edcf2015f",
"content_url": "https://portal.edirepository.org/nis/dataviewer?packageid=knb-lter-pal.220.3&entityid=e03b43c924f226486f2f0ab6709d2381",
"path_posix": "raw/gentoo.csv",
"size_in_bytes": 11263
},
{
"checksum_md5": "e4b0710c69297031d63866ce8b888f25",
"content_url": "https://portal.edirepository.org/nis/dataviewer?packageid=knb-lter-pal.221.2&entityid=fe853aa8f7a59aa84cdd3197619ef462",
"path_posix": "raw/chinstrap.csv",
"size_in_bytes": 18872
}
],
"author": [
{
"author_type": "Person",
"orcid": "0000-0002-6047-5564",
"affiliation": [
"UC Santa Barbara: Santa Barbara, CA, US"
],
"email": "[email protected]",
"name": "Allison Horst"
},
{
"author_type": "Person",
"orcid": "0000-0002-8082-1890",
"affiliation": [
"RStudio: Boston, MA, US"
],
"email": "[email protected]",
"name": "Alison Hill"
},
{
"author_type": "Person",
"orcid": "0000-0002-0258-9264",
"affiliation": [
"University of Alaska Fairbanks: Fairbanks, AK, US"
],
"email": "[email protected]",
"name": "Kristen Gorman"
}
],
"publication": [
{
"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.",
"date_published": "2014-03-05",
"doi": "https://doi.org/10.1371/journal.pone.0090081"
}
],
"funding": [
{
"funder": "NSF-OPP",
"identifier": "#0217282",
"url": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0217282&HistoricalAwards=false"
},
{
"funder": "NSF-OPP",
"identifier": "#0823101",
"url": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0823101&HistoricalAwards=false"
},
{
"funder": "NSF-OPP",
"identifier": "#0741351",
"url": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=0741351&HistoricalAwards=false"
}
]
}
Empty file.
Loading

0 comments on commit 87244ec

Please sign in to comment.