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

Add: All outputs should be named

Browse source
This commit is contained in:
Gregor Sturm 2020-07-14 16:13:05 +02:00 committed by GitHub
parent 8f3718795b
commit 7121879714
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -65,10 +65,11 @@ Currently the following points have been agreed on:
- Define threads or resources where required for a particular process using - Define threads or resources where required for a particular process using
`task.cpus` `task.cpus`
- Software that can be piped together should be added to separate module files unless there is an run-time, storage advantage in implementing in this way e.g. `bwa mem | samtools view` to output BAM instead of SAM - Process names should be all uppercase - Software that can be piped together should be added to separate module files unless there is an run-time, storage advantage in implementing in this way e.g. `bwa mem | samtools view` to output BAM instead of SAM - Process names should be all uppercase
- The `publishDirMode` should be configurable - The `publishDirMode` should be configurable via `params.publish_dir_mode`
- Test data is stored within this repo. Re-use generic files from `tests/data` by symlinking them into the test directory of the module. Add specific files to the test-directory directly. Keep test files as tiny as possible. - Test data is stored within this repo. Re-use generic files from `tests/data` by symlinking them into the test directory of the module. Add specific files to the test-directory directly. Keep test files as tiny as possible.
- Software requirements should be declared in a conda `environment.yml` file, including exact version numbers. Additionally, there should be a `Dockerfile` that containerizes the environment. - Software requirements should be declared in a conda `environment.yml` file, including exact version numbers. Additionally, there should be a `Dockerfile` that containerizes the environment.
- Each process should emit a file `TOOL.version.txt` containing a single line with the software's version in the format `vX.X.X`. - Each process should emit a file `TOOL.version.txt` containing a single line with the software's version in the format `vX.X.X`.
- All outputs should be named
### Testing ### Testing