Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Metagenomics
snakemake
Commits
a7e1c446
Commit
a7e1c446
authored
May 10, 2019
by
Kenzo-Hugo Hillion
♻
Browse files
start Documentation for Snakemake tools
parent
73abde0f
Changes
1
Hide whitespace changes
Inline
Side-by-side
tools/README.md
View file @
a7e1c446
...
...
@@ -4,3 +4,15 @@ This directory contains all tool description that can be imported and used withi
Every rules for a tool should come with an example of use in a workflow as well as a
`config.yaml`
example file (usually containing default parameters that are set up on the
`.rules`
file itself).
## Design and best practices
All Snakemake tool descriptions try to respect some rules and best practices in their design:
*
First part correspond to all options that are set up from a
`config.yaml`
file
*
Then the tool itself is described with:
*
input with the nomenclature:
`__TOOLNAME_input`
*
output with the nomenclature:
` __TOOLNAME_output`
*
params with different options that are described above
input and output are then set up in the Snakemake file that refer to the rule.
\ No newline at end of file
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment