Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
snakemake
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Metagenomics
snakemake
Commits
a7e1c446
Commit
a7e1c446
authored
6 years ago
by
Kenzo-Hugo Hillion
Browse files
Options
Downloads
Patches
Plain Diff
start Documentation for Snakemake tools
parent
73abde0f
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
tools/README.md
+12
-0
12 additions, 0 deletions
tools/README.md
with
12 additions
and
0 deletions
tools/README.md
+
12
−
0
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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
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!
Save comment
Cancel
Please
register
or
sign in
to comment