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

Make PRC compatible with RO-Crate #57

Open
hvwaldow opened this issue Jan 14, 2025 · 2 comments
Open

Make PRC compatible with RO-Crate #57

hvwaldow opened this issue Jan 14, 2025 · 2 comments
Labels

Comments

@hvwaldow
Copy link
Collaborator

No description provided.

@aleidel
Copy link
Contributor

aleidel commented Jan 14, 2025

rocrate missing name, description and license of RootEntity
if instead following command is used, license is added at right level, license error solved: runcrate convert ./run/ -w workflows/demo/demo.cwl --output ./rocrate --license "someLicense"
annotating the cwl file with doc: someDescription would add "description": "someDescription" to the ro-crate-metadata.json file in block with id "packed.cwl" (but this is the wrong scope for the ro-crate validator, still error missing description)
name can be given by label in cwl file but is overwritten if -w is specified in runcrate command, "name": "someName" is also part of block with id "packed.cwl" but still error with validation tool (ROOT data Entity must have a name)

@JensKrumsieck
Copy link
Collaborator

JensKrumsieck commented Jan 15, 2025

Thanks for clarification. I looked into the runcrate code.

If i did not miss a thing license is the only metadata it can add to RootEntity using convert command:
https://github.com/ResearchObject/runcrate/blob/802bd3c43696c88821f75c3ec528573e06679521/src/runcrate/convert.py#L303C4-L311C1

   def add_root_metadata(self, crate):
       if self.license:
           crate.root_dataset["license"] = self.license
       if self.readme:
           readme = crate.add_file(self.readme)
           readme["about"] = crate.root_dataset
           if self.readme.suffix.lower() == ".md":
               readme["encodingFormat"] = "text/markdown"

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

No branches or pull requests

3 participants