Skip to content

Commit

Permalink
docs: Use one tag in all of the examples
Browse files Browse the repository at this point in the history
Co-authored-by: Harshil Patel <[email protected]>
  • Loading branch information
edmundmiller and drpatelh committed Feb 9, 2021
1 parent 9637a81 commit 4c30f29
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,23 +275,25 @@ In order to test that each module added to `nf-core/modules` is actually working
```console
cd /path/to/git/clone/of/nf-core/modules/
PROFILE=docker pytest --tag tests/software/bowtie/build --symlink --wt 2 --keep-workflow-wd
PROFILE=docker pytest --tag bowtie --symlink --wt 2 --keep-workflow-wd
```
- Typical command with Singularity:
```console
cd /path/to/git/clone/of/nf-core/modules/
TMPDIR=~ PROFILE=singularity pytest --tag star --symlink --wt 2 --keep-workflow-wd
TMPDIR=~ PROFILE=singularity pytest --tag bowtie --symlink --wt 2 --keep-workflow-wd
```
- Typical command with Conda:
```console
cd /path/to/git/clone/of/nf-core/modules/
PROFILE=conda pytest --tag star --tag star_align_paired_end --symlink --wt 2 --keep-workflow-wd
PROFILE=conda pytest --tag bowtie --symlink --wt 2 --keep-workflow-wd
```
- See [docs on running pytest-workflow](https://pytest-workflow.readthedocs.io/en/stable/#running-pytest-workflow) for more info.
### Documentation
- A module MUST be documented in the [`meta.yml`](software/TOOL/SUBTOOL/meta.yml) file. It MUST document `params`, `input` and `output`. `input` and `output` MUST be a nested list.
Expand Down

0 comments on commit 4c30f29

Please sign in to comment.