Skip to content
GitLab
Menu
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
7d24d76f
Commit
7d24d76f
authored
May 10, 2019
by
Kenzo-Hugo Hillion
♻
Browse files
continue README for tool descriptions
parent
a7e1c446
Changes
1
Hide whitespace changes
Inline
Side-by-side
tools/README.md
View file @
7d24d76f
...
...
@@ -9,10 +9,13 @@ example file (usually containing default parameters that are set up on the `.rul
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
*
First part correspond to all options that are set up from a
`config.yaml`
file
. They all have the nomenclature
`__TOOLNAME_variable`
.
*
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
*
There is usually a
`exec_command`
to give the possibility to change the way the tool is called (locally installed, singularity ...)
*
There is usually a
`options`
to specify all other command line options
*
the shell command
input and output are then set up in the Snakemake file that refer to the rule.
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a 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