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

conformsTo profile applies to root dataset, not metadata file #229

Merged
merged 5 commits into from
Mar 9, 2023

Conversation

stain
Copy link
Contributor

@stain stain commented Jan 16, 2023

To indicate RO-Crate following a particular profile, then move so "conformsTo" applied to "./" as suggested in #153 (comment) (and agreed in calls 2022-09-08 and 2022-01-27) rather than on ro-crate-metadata.json entity.

This means conformsTo on the ro-crate-metadata.json is only for RO-Crate spec itself (considering it from a JSON/JSON-LD perspective) while profiles about the content/shapes of a class of crates are appliec using conformsTo on the root dataset (./)

This also makes it easier to link to other RO-Crates as a Dataset and saying they follow a particular profile -- however you would also need to add a subjectOf to link to their ro-crate-metadata.json in order to indicate it is an RO-Crate - so still not ideal.

(also there is still no way to indicate RO-Crate-ness on a nested Dataset which has a distribution to a Zip/tar DataDownload according to https://www.researchobject.org/ro-crate/1.1/data-entities.html#directories-on-the-web-dataset-distributions.)

See also ResearchObject/workflow-run-crate#40 which applies this on the Workflow Run Crate profiles.

This fixes #126

@stain stain requested a review from ptsefton January 16, 2023 13:31
stain added a commit that referenced this pull request Jan 16, 2023
Example: https://by-covid.github.io/baseline-use-case-synthetic-crate/ro-crate-preview.html#vaccines_effectiveness_common_data_model_specification/data/metadata/attributes.csv

```json
 {
  "@id": "attributes.csv",
  "@type": "File",
  "encodingFormat": ["text/csv", {"@id": "https://www.nationalarchives.gov.uk/PRONOM/x-fmt/18"}],
  "conformsTo": {"@id": "https://docs.ropensci.org/dataspice/#create-spice"}
 },
 {
  "@id": "https://docs.ropensci.org/dataspice/#create-spice",
  "@type": "CreativeWork",
  "name": "dataspice CSV profile"
 }
```

adds note to explain conformsTo used on ro-crate-metadata.json and root dataset for profiles

This assumes #229
@stain
Copy link
Contributor Author

stain commented Jan 26, 2023

Copy link
Contributor

@simleo simleo left a comment

Choose a reason for hiding this comment

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

I've changed (4b4f5d9) the profile crate retrieval section to use Workflow RO-Crate for all examples. This way, since Workflow RO-Crate has a profile crate, readers can actually try following the instructions and check that they get JSON-LD when requested.

@stain stain merged commit 128e682 into master Mar 9, 2023
@stain stain deleted the profile-conformsTo-on-root branch March 23, 2023 20:57
@stain stain added this to the RO-Crate 1.2 milestone Mar 23, 2023
@stain stain mentioned this pull request Apr 28, 2023
29 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants