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.

Sign up for GitHub

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

some reorganization of text, add rec's about @id for metadata record … #246

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

some reorganization of text, add rec's about @id for metadata record … #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6a0bc8
some reorganization of text, add rec's about @id for metadata record …
smrgeoinfo Aug 25, 2023
1b03403
update a couple examples and the dataset guide wtih 'about' approach
smrgeoinfo Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 253 additions & 0 deletions examples/dataset/full_about.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
{
"@context": [
"https://schema.org/",
{
"prov": "http://www.w3.org/ns/prov#",
"provone": "http://purl.dataone.org/provone/2015/01/15/ontology#",
"spdx": "http://spdx.org/rdf/terms#"
}
],
"@id":"metatada.lod.example-data-repository.org/id/dataset/3300",
"@type":"DigitalDocument",
"creator":
{
"@type":"Organization",
"name":"Science on Schema.org Workgroup",
"url":"https://github.com/ESIPFed/science-on-schema.org"
},
"dateModified":"2023-11-09",
"schemaEncodingFormat":"https://github.com/ESIPFed/science-on-schema.org/Dataset",
"about": {
"@id": "http://lod.example-data-repository.org/id/dataset/3300",
"@type": "Dataset",
"identifier": {
"@type": "PropertyValue",
"propertyID": "https://registry.identifiers.org/registry/doi",
"value": "doi:10.1234/1234567890",
"url": "https://doi.org/10.1234/1234567890",
"sameAs": "http://doi.org/abcd"
},
"sameAs": "https://doi.org/10.1234/1234567890",
"isAccessibleForFree": true,
"url": "https://www.example-data-repository.org/dataset/3300",
"name": "Larval krill studies - fluorescence and clearance from ARSV Laurence M. Gould LMG0106, LMG0205 in the Southern Ocean from 2001-2002 (SOGLOBEC project)",
"alternateName": "larval krill pigments",
"description": {
"@type": "HTML",
"@value": "<p>"Winter ecology of larval krill: quantifying their interaction with the pack ice habitat"</p>\r\n\r\n<p>The goal of the larval krill studies was to investigate the physiology and ecology of krill larvae associated with the pack ice and the microbial community on which they feed.</p>\r\n\r\n<p>During LMG0106 we occupied two 4-5 day ice stations (Robert and Billy) and sampled several other ice floes opportunistically. We conducted 10 instantaneous growth rate experiments, and 4 whole body clearance time experiments to determine gut passage time (decline in pigment content over time). We also sampled larvae at two additional sites for initial body pigment content (whole body fluorescence), and at 4 sites for condition factor. The under-ice algal community was sampled at one site. Length and stage frequency determinations were also determined.</p>\r\n\r\n<p>We occupied three time-series stations of approximately 1 week each, and in addition opportunistically sampled at times when other activities had priority. Our primary goal during the cruise was to occupy three ice camps or process stations with the intent of thoroughly studying the under-ice environment by SCUBA in conjunction with other projects working topside. <a href="http://www.ccpo.odu.edu/Research/globec/main_cruises02/lmg0205/report_lmg0205.pdf" target="_blank"><em>(from cruise report LMG0205)</em></a></p>"
},
"datePublished": "2010-02-03",
"keywords": [
{
"@type": "DefinedTerm",
"name": "OCEANS",
"inDefinedTermSet": "https://gcmd.earthdata.nasa.gov/kms/concepts/concept_scheme/sciencekeywords",
"url": "https://gcmd.earthdata.nasa.gov/kms/concept/91697b7d-8f2b-4954-850e-61d5f61c867d",
"termCode": "91697b7d-8f2b-4954-850e-61d5f61c867d"
},
{
"@type": "DefinedTerm",
"name": "ice core studies",
"inDefinedTermSet": "https://vocabularyserver.com/cnr/ml/snowterm/en/",
"url": "https://vocabularyserver.com/cnr/ml/snowterm/en/index.php?tema=29330",
"identifier": {
"@type": "PropertyValue",
"propertyID": "https://registry.identifiers.org/registry/ark",
"value": "ark:/99152/t3v4yo3eeqepj0",
"url": "https://vocabularyserver.com/cnr/ml/snowterm/en/?ark=ark:/99152/t3v4yo3eeqepj0"
}
},
{
"@type": "DefinedTerm",
"name": "Baked Clay",
"inDefinedTermSet": "https://www2.earthref.org/vocabularies/controlled"
}
],
"creator": {
"@list": [
{
"@type": "Person",
"@id": "http://lod.example-data-repository.org/id/person/51159",
"name": "Dr Langdon Quetin",
"url": "https://www.example-data-repository.org/person/51159"
},
{
"@type": "Person",
"@id": "http://lod.example-data-repository.org/id/person/51160",
"name": "Dr Robin Ross",
"url": "https://www.example-data-repository.org/person/51160"
}
]
},
"citation": "Quetin, L., Ross, R. (2010) Larval krill studies - fluorescence and clearance from ARSV Laurence M. Gould LMG0106, LMG0205 in the Southern Ocean from 2001-2002 (SOGLOBEC project). Example Data Repository. Version 1. doi:10.1234/1234567890 [access date]",
"version": "1",
"license": "https://creativecommons.org/licenses/by/4.0/",
"temporalCoverage": "2001-08-06/2002-09-09",
"spatialCoverage": {
"@type": "Place",
"geo": {
"@type": "GeoShape",
"box": "-68.4817 -75.8183 -65.08 -68.5033"
},
"additionalProperty": [
{
"@type": "PropertyValue",
"propertyID": "http://www.wikidata.org/entity/Q4018860",
"name": "well-known text (WKT) representation of geometry",
"value": "POLYGON ((-75.8183 -68.4817, -68.5033 -68.4817, -68.5033 -65.08, -75.8183 -65.08, -75.8183 -68.4817))"
},
{
"@type": "PropertyValue",
"propertyID": "http://www.wikidata.org/entity/Q161779",
"name": "Spatial Reference System",
"value": "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
}
]
},
"publisher": {
"@type": "Organization",
"name": "Example Data Repository",
"url": "https://www.example-data-repository.org"
},
"provider": {
"@type": "Organization",
"name": "Example Data Repository",
"url": "https://www.example-data-repository.org"
},
"distribution": [
{
"@type": "DataDownload",
"contentUrl": "https://www.example-data-repository.org/dataset/3300/data/larval-krill.tsv",
"encodingFormat": "text/tab-separated-values",
"datePublished": "2010-02-03",
"spdx:checksum": [
{
"@type": "spdx:Checksum",
"spdx:checksumValue": "39ae639d33cea4a287198bbcdca5e6856e6607a7c91dc4c54348031be2ad4c51",
"spdx:checksumAlgorithm": {"@id": "spdx:checksumAlgorithm_sha256"}
},
{
"@type": "spdx:Checksum",
"spdx:checksumValue": "65d3616852dbf7b1a6d4b53b00626032",
"spdx:checksumAlgorithm": {"@id": "spdx:checksumAlgorithm_md5"}
}
]
}
],
"measurementTechnique": [
"Hand-held plankton net",
"Manual Biota Sampler"
],
"variableMeasured": [
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20860",
"name": "cruiseid",
"description": "cruise identification",
"unitText": "text"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20861",
"name": "year",
"description": "year of experiment",
"unitText": "calendar year"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20862",
"name": "sample_id",
"description": "sample identification: WBC=whole body clearance expt.; WBF=whole body fluorescence on collection"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20863",
"name": "time_sample",
"description": "Number of minutes between collection and sampling for pigment content; decline of pigment content with time was used to calculate time to clear the gut of pigment.",
"unitText": "minutes"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20864",
"name": "pigment_content",
"description": "pigment content",
"unitText": "micrograms total chl/grams wet weight"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20865",
"name": "stage_id",
"description": "stage development index of larvae in sample (furcilia = F1-6 = 1-6, juvenile = J=7)"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20866",
"name": "wet_weight",
"description": "average wet weight/larvae in sample",
"unitText": "mg"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20874",
"name": "lat",
"description": "latitude, in decimal degrees, North is positive, negative denotes South",
"unitText": "decimal degrees"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20875",
"name": "lon",
"description": "longitude, in decimal degrees, East is positive, negative denotes West",
"unitText": "decimal degrees"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20876",
"name": "day_local",
"description": "day of month, local time"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20877",
"name": "month_local",
"description": "month, local time"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20878",
"name": "time_local",
"description": "time of day, local time, using 2400 clock format"
},
{
"@type": "PropertyValue",
"propertyID": "http://lod.example-data-repository.org/id/dataset-parameter/20879",
"name": "yrday_local",
"description": "local day and decimal time, as 326.5 for the 326th day of the year, or November 22 at 1200 hours (noon)"
}
],
"funding": {
"@id": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=9909933",
"@type": "MonetaryGrant",
"identifier": "9909933",
"name": "GLOBEC: Winter Ecology of Larval Krill: Quantifying their Interaction with the Pack Ice Habitat",
"url": "https://www.nsf.gov/awardsearch/showAward?AWD_ID=9909933",
"funder": {
"@id": "http://dx.doi.org/10.13039/100000001",
"@type": "Organization",
"name": "National Science Foundation",
"identifier": [
"http://dx.doi.org/10.13039/100000001",
"https://ror.org/021nxhr62"
]
}
},
"prov:wasDerivedFrom": {"@id": "https://doi.org/10.xxxx/Dataset-1"},
"schema:isBasedOn": {"@id": "https://doi.org/10.xxxx/Dataset-1"},
"prov:wasGeneratedBy": {
"@id": "https://example.org/executions/execution-42",
"@type": "provone:Execution",
"prov:hadPlan": "https://somerepository.org/datasets/10.xxxx/Dataset-2.v2/process-script.R",
"prov:used": {"@id": "https://doi.org/10.xxxx/Dataset-1"}
}
}
}
24 changes: 24 additions & 0 deletions examples/dataset/minimal_about.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"@context": "https://schema.org/",
"@id": "https://example.org/metadata/1234567890",
"@type": "DigitalDocument",
"dateModified": "2023-11-09",
"schemaEncodingFormat": "https://github.com/ESIPFed/science-on-schema.org/Dataset",
"about": {
"@type": "Dataset",
"@id": "https://example.org/datasets/1234567890",
"identifier": "doi:10.1234/1234567890",
"name": "Removal of organic carbon by natural bacterioplankton communities as a function of pCO2 from laboratory experiments between 2012 and 2016",
"description": "A description between 50 and 5000 characters.",
"url": "https://example.org/datasets/1234567890",
"version": "2013-11-21",
"keywords": [
"ocean acidification",
"OA",
"oceans"
],
"license": "CC-BY-4.0",
"sameAs": "https://doi.org/10.1234/1234567890",
"isAccessibleForFree": "true"
}
}
42 changes: 42 additions & 0 deletions guides/Dataset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,50 @@
- [Checksum](#checksum)
- [Provenance Relationships](#provenance-relationships)


<!-- /TOC -->

## Structure of the metadata record

A metadata record has two parts; one part is about the metadata record itself, the other part is the content about the resource that the metadata documents. The part about the record specifies the identifier for the metadata record, agents with responsibility for the record, when it was last updated, what specification or profiles the metadata serialization conforms to, and other optional properties of the metadata that are deemed useful. The metadata about the resource has properties about the resource like title, description, responsible parties, spatial or temporal extent, distribution information, etc.

The recommended approach is to flag statements documenting the resource inside an about property:

```
{ "@context": [
"https://schema.org",
{"dct": "http://purl.org/dc/terms/",
"soso":"https://github.com/ESIPFed/science-on-schema.org/releases/tag/",
"ex":"https://example.com/99152/" }
],
"@id": "ex:URIforTheMetadata",
"@type": "DigitalDocument",
"dateModified": "2023-05-23",
"dct:conformsTo": {"@id":"soso:1.3.1"},
"about": {
"@id": "ex:URIforDescribedResource",
"@type": {URI for the type of the described resource},
"dateModified": "2014-02-23",
"name": "title to identify resource",
... other metadata
} }
```

In the example above, there is a 'dateModified' metadata assertion. It would translate into a triple like this:

```ex:URIforThisMetadataRecord schema:dateModified "2023-05-23" ```

Which states that the Metadata was modified (most recently) on 2023-05-23. The dct:conformsTo property is used to assert that the metadata conforms to the ESIPfed Science on Schema.org recommendations.

On the other hand, in the 'about' object, there is a statement:

```ex:URIforDescribedResource schema:dateModified "2014-02-23" ```

Which states that the DescribedResource was modified (most recently) on 2014-02-23. The distinct identifier for the metadata record allows statements to be made about the metadata separately from statements about the resource it describes. Note that the @type for the metadata node is 'DigitalDocument'. This is a schema.org type that corresponds broadly to the concept of DigitalObject as used by the [Fair Digital Object](https://fairdigitalobjectframework.org/) (FDO) community, recognizing that the metadata record is a digital object.

See the [discussion of 'Identifier'](https://github.com/ESIPFed/science-on-schema.org/blob/master/guides/Dataset.md#identifier) section for a more in-depth discussion about identifiers for documented resources.


## Common Properties

Google has drafted a [guide to help publishers](https://developers.google.com/search/docs/data-types/dataset). The guide describes the only required fields as - name and description.
Expand Down
Loading