Description:
In order to share CNVand with the scientific community, it would be great to upload to WorkflowHub. This process will ensure the workflow is automatically parsed and encapsulated into a Research Object Crate, complying with the FAIR principles of scientific data.
To meet the high standards of WorkflowHub, our current Snakemake repository structure needs to be extended with the following elements:
Code of Conduct
Contribution Instructions
Workflow Rule Graph
Workflow Documentation
Test Directory
Tasks:
Add a CODE_OF_CONDUCT.md file for repository developers.
Add a CONTRIBUTING.md file with instructions on how to contribute to the project.
Generate and add an SVG-formatted rule graph at images/rulegraph.svg.
Create detailed workflow documentation and place it in workflow/documentation.md.
Set up a .tests directory with:
integration subdirectory for integration tests, including input data, configuration specifications, and shell commands.
unit subdirectory for unit tests of individual workflow steps.
Description: In order to share CNVand with the scientific community, it would be great to upload to WorkflowHub. This process will ensure the workflow is automatically parsed and encapsulated into a Research Object Crate, complying with the FAIR principles of scientific data.
To meet the high standards of WorkflowHub, our current Snakemake repository structure needs to be extended with the following elements:
Tasks:
CODE_OF_CONDUCT.mdfile for repository developers.CONTRIBUTING.mdfile with instructions on how to contribute to the project.images/rulegraph.svg.workflow/documentation.md..testsdirectory with:integrationsubdirectory for integration tests, including input data, configuration specifications, and shell commands.unitsubdirectory for unit tests of individual workflow steps.