millironx/nf-core_modules
1
0
Fork 0
mirror of https://github.com/MillironX/nf-core_modules.git synced 2024-12-22 11:08:17 +00:00
Code Issues Releases Packages Activity

docs: Use one tag in all of the examples

Browse source 
Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>
This commit is contained in:
Edmund Miller 2021-02-08 20:11:48 -06:00
parent 9637a8189a
commit 4c30f2943e
No known key found for this signature in database
GPG key ID: BD387FF7BC10AA9D
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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.