Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions _extras/recommended-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,13 @@ Below are a set of recommended good practices to keep in mind when writing a Com

☐ Give the tool description to a colleague (preferably at a different institution) to test and provide feedback.

☐ CWL implementations which also implement [`SubworkflowFeatureRequirement`][subworkflow] can support nesting workflows as a step within others. Complex workflows with individual components which can be abstracted should utilise this to make their workflow modular and allow sections of them to be easily reused.

[apache-license]: https://www.apache.org/licenses/LICENSE-2.0#apply
[license-example]: https://github.com/ProteinsWebTeam/ebi-metagenomics-cwl/blob/master/workflows/emg-assembly.cwl#L200
[scicrunch-issue]: https://github.com/common-workflow-language/common-workflow-language/issues/scicrunch.org
[edam-example]: http://edamontology.org/format_1915
[iana-types]: http://www.iana.org/assignments/media-types/media-types.xhtml
[file-prop]: http://www.commonwl.org/v1.0/CommandLineTool.html#File
[orcid]: https://orcid.org
[subworkflow]: http://www.commonwl.org/v1.0/Workflow.html#SubworkflowFeatureRequirement