From 4c30f2943e0a5d388ef4a500887d1888ac2614bf Mon Sep 17 00:00:00 2001 From: Edmund Miller Date: Mon, 8 Feb 2021 20:11:48 -0600 Subject: [PATCH] docs: Use one tag in all of the examples Co-authored-by: Harshil Patel --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fa88cd49..28646f5f 100644 --- a/README.md +++ b/README.md @@ -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.