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.

Sign up for GitHub

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

Jump to bottom

Refactor RO Crate #47

Merged
merged 4 commits into from
Sep 11, 2024
Merged

Refactor RO Crate #47

merged 4 commits into from
Sep 11, 2024

Conversation

alexhambley
Copy link
Collaborator

@alexhambley alexhambley commented Sep 11, 2024 •
edited
Loading

Addresses:
#36, #38, #39, #40

Highlights:
Adds source files, Dockerfile and poetry.lock to RO Crate
RO Crate now conforms to Workflow Run RO Crate
Tidied up and added newer diagram to readme

@alexhambley
RO crate will now contain source files (#39)
06cf57e 
- Partially addresses #39
- Now adds source files, Dockerfile and poetry.lock
- References mainEntity
- Removed rocrate-zenodo from pip install as upload will be external to the workflow.
@alexhambley
Update example RO crate (#39)
7acea3a 
- Addresses #39
- RO crate now includes source files and better conforms to workflow run RO crate
- Includes mainEntity, conformsTo and references to source files
- Snakemake component now represented correctly
@alexhambley
create_ro_crate.py now builds an RO crate that better fits workflow r…
f2bab54 
…un profile (#39)

- Addresses #39
- create_ro_crate.py refactored and updated to create crate that includes CreateAction with relevant metadata
- Metadata added to Dockerfile
- Example RO Crate Metadata updated to reflect this
@alexhambley
Update authors and readme.md
8db4f9c 
- Addresses #40, #39, #38, #36
- Added newer diagram to readme.
- Removed references to ghcr, this will be added back later
- Added proper authors and orcids
- Replaced Dockerfile encodingFormat with text/plain
- Added created_files.json to RO Crate and added to data_entity["isBasedOn"].
OliverWoolland
OliverWoolland approved these changes Sep 11, 2024
View reviewed changes
Copy link
Collaborator

@OliverWoolland OliverWoolland left a comment

Choose a reason for hiding this comment

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

Approving but I think it would be good to:

  • decide if example intermediate outputs should be included or their generation documented
  • decide if example outputs should be included in the versioning or as release artifacts
  • checks should be passing

@alexhambley alexhambley merged commit 71f1dca into develop Sep 11, 2024
1 of 3 checks passed
@alexhambley alexhambley deleted the refactor-ro-crate branch September 11, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OliverWoolland OliverWoolland OliverWoolland approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alexhambley @OliverWoolland