Skip to content

Commit

Permalink
readme and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
johanneskoester committed Apr 9, 2021
1 parent eccbbc1 commit c446ab3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
File renamed without changes.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,23 @@ To generate a new structure using this template, run

with path pointing to the desired output directory.

You will get the following structure:
You will get the following structure:

├── copier.yml
├── README.md
├── .template
│   ├── config
│   │   └── config.yaml.tmpl
│   └── workflow
│   └── Snakefile.tmpl
└── workflow
├── rules
│   └── common.smk
└── Snakefile

The `workflow` folder contains the structure to put the actual workflow in.
Make sure to follow the [best practices](https://snakemake.readthedocs.io/en/stable/snakefiles/deployment.html#distribution-and-reproducibility).

The `.template` folder contains an automatically generated template for deploying the workflow using Snakemake's [module system](https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html#snakefiles-modules).
Here, you should edit the `config.yaml.tmpl` to contain the config settings you would like to initialize in the deployment of the user.
It is possible to add further files needed for the configuration to the `.template` folder, e.g. sample sheets.

0 comments on commit c446ab3

Please sign in to comment.