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

Package metadata to meet FAIR requirements of model outputs (RO-crate) #25

Open
simonrolph opened this issue Sep 5, 2023 · 5 comments

Comments

@simonrolph
Copy link
Collaborator

Add all references to relevant objects on the wiki

@simonrolph simonrolph changed the title Create RO-crate meta data Package metadata to meet FAIR requirements of model outputs (RO-crate) Sep 6, 2023
@simonrolph
Copy link
Collaborator Author

@stopopol @juliancervos Could you provide some more information about what meta data we need to provide?

Am I correct in thinking we are using RO-crate? https://www.researchobject.org/ro-crate/

@stopopol
Copy link
Collaborator

stopopol commented Sep 6, 2023

As far as I know yes. Details are yet to be specific though. I suggest adding an empty folder to the repo (e.g. "WP5 metadata") which will be populated (either automatically or manually) at a later point.

@juliancervos
Copy link
Collaborator

Yes, we're using RO-Crate. We're trying to establish some common metadata attributes across pDTs so things are coherent (the "metadata profiles", see this example), starting with the models. So before tackling the metadata for the model outputs (as in the issue title), I think it's useful to have some metadata for other elements first, like the models, the data, etc.

I've written a basic RO-Crate metadata file for the biodiversity model following the profile I linked, but I couldn't push it to the repo because I don't have write access (ERROR: Write access to repository not granted.).

@simonrolph Could you give me write access for this repo? Then I'll push the metadata file I mentioned and add some comments about it here.

@simonrolph
Copy link
Collaborator Author

@juliancervos I should have given write access now

@juliancervos
Copy link
Collaborator

Yes, got it!

I've uploaded a basic RO-Crate metadata file for the biodiversity model to the new metadata folder. I filled it in with some info that I could find in the repo, so probably some things are not accurate (i.e. "dateCreated", "description", "softwareVersion", "softwareRequirements"...). It would be great if you could check it out and correct things (or just let me know about it, or we can discuss it during the next meeting). Things that need to be updated/reviewed:

  • Check that the current information is accurate.
  • Add ORCiDs for all authors.
  • Also, I added the MIT license for the repo, let me know if you'd like to change it.

The metadata profiles (for BioDT models, but also for data, workflows...) will keep evolving, so more metadata will be needed as we keep refining them, but I will take care of updating all that and letting you know when it happens and so on.

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

3 participants