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

YAML files will need something for Dataset with the minimum props for a crate (none in process_run.yaml) #9

Open
ptsefton opened this issue Feb 14, 2025 · 3 comments

Comments

@ptsefton
Copy link

This is an issue for all profiles -- do they aim to specify enough to make a useful data package (I think they should) see this issue ResearchObject/workflow-run-crate#88

I would expect to see something like this with some help-text to encourage users to fill out contextual info like author/creator

classes:
  Dataset:
    comments:
    - The entry point to a workflow RO-Crate
    is_a: CreativeWork
    class_uri: wfrun:Dataset
    slots:
    - name
    - description
    - datePublished
    - license
    - mainEntity
    - author
    - publisher
@ptsefton ptsefton changed the title YAML files will need something for Dataset with the minimum props for a crate YAML files will need something for Dataset with the minimum props for a crate (none in process_run.yaml) Feb 14, 2025
@multimeric
Copy link
Collaborator

You're referring to the root data entity here, correct?

I suppose the best way to do this in LinkML is define this as a new class, because it doesn't make sense to re-define Dataset globally, which needs to be re-used for other directories. So I envisage something like:

classes:
  ProcessRunDataset:
    comments:
    - The entry point to a workflow RO-Crate
    is_a: CreativeWork
    class_uri: wfrun:Dataset
    slots:
      [...]
    - datePublished
   slot_usage:
     datePublished:
       required: true

Then they will need to declare their root data entity as a:

"@type": ["Dataset", "ProcessRunDataset"]

@ptsefton
Copy link
Author

I think it would be better to treat this an new class that's RO-Crate specific - not tied to the particular profile. This profile does not need its own wfrun: prefix as it only uses terms from published schemas. So something like ROCrateDataset -- that your tools treat as a "magic" definition when generating validation shapes, modes, etc

@multimeric
Copy link
Collaborator

Good point. In this case it will be resolved when I'm able to make a schema for RO-Crate itself, which can define an implicit ,RootDataEntity class. Then profiles will be able to customize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants