ResearchObject / ro-crate

Research Object Crate
https://w3id.org/ro/crate/
Apache License 2.0
79 stars 34 forks source link

Update docs on finding the root dataset #198

Closed simleo closed 1 year ago

simleo commented 2 years ago

Updates the root data entity section as follows:

Note that, in order to make this PR independent from #189, I've avoided using the term "detached crate". If we merge that PR first, however, we should change this one to explicitly mention detached crates.

simleo commented 2 years ago

Re: the nested crate example, it would be nice to recommend adding a conformsTo to the relevant entry in order to indicate that it's an RO-Crate:

    {
      "@id": "http://example.org/crate/nested/",
      "@type": "Dataset",
      "conformsTo": {"@id": "https://w3id.org/ro/crate/1.2-DRAFT"}
    }

I haven't included that in this PR since in the current spec the conformsTo applies to the metadata file descriptor. However, we're planning to move it to the crate, so we can make this change after we've done that.

stain commented 1 year ago

We agreed that implementation can try to be lax and rescue user -- but spec should be more strict. Don't suggest the heuristics. Just note to not expose internals of nested crates as it could confuse root dataset algorithm.

simleo commented 1 year ago

@stain #183 was closed yesterday but this PR is still open.

We agreed that implementation can try to be lax and rescue user -- but spec should be more strict. Don't suggest the heuristics. Just note to not expose internals of nested crates as it could confuse root dataset algorithm.

Commits 588e536, fe6e479 and e15f6ae did just that. Is there anything else that's preventing this PR from being merged?

ptsefton commented 1 year ago

@stian where is this up to?

stain commented 1 year ago

Merging without review as call 2023-03-23 agreed to merge all outstanding PR (that are not WIP) so we can do an overall review and push out 1.2.