Commit a7e1c446 authored by Kenzo-Hugo Hillion's avatar Kenzo-Hugo Hillion
Browse files

start Documentation for Snakemake tools

parent 73abde0f
......@@ -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
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment