Update docs

This commit is contained in:
drpatelh 2020-10-15 11:13:54 +01:00
parent 7e2c7b1b41
commit 29f9b05433
13 changed files with 13 additions and 78 deletions

View file

@ -32,7 +32,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -49,11 +49,6 @@ input:
description: | description: |
List of input FastQ files of size 1 and 2 for single-end and paired-end data, List of input FastQ files of size 1 and 2 for single-end and paired-end data,
respectively. respectively.
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
## TODO nf-core: Add a description of all of the variables used as output ## TODO nf-core: Add a description of all of the variables used as output
output: output:
- meta: - meta:

View file

@ -24,7 +24,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -33,11 +33,6 @@ input:
- fasta: - fasta:
type: file type: file
description: Input genome fasta file description: Input genome fasta file
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- index: - index:
type: file type: file

View file

@ -27,7 +27,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -50,11 +50,6 @@ input:
- fasta: - fasta:
type: file type: file
description: Input genome fasta file description: Input genome fasta file
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- bam: - bam:
type: file type: file

View file

@ -26,7 +26,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -42,11 +42,6 @@ input:
description: | description: |
List of input FastQ files of size 1 and 2 for single-end and paired-end data, List of input FastQ files of size 1 and 2 for single-end and paired-end data,
respectively. respectively.
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -25,7 +25,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -43,11 +43,6 @@ input:
- fasta: - fasta:
type: file type: file
description: Genome fasta file description: Genome fasta file
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -25,7 +25,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -40,11 +40,6 @@ input:
type: file type: file
description: BAM file description: BAM file
pattern: "*.{bam}" pattern: "*.{bam}"
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -23,7 +23,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -38,11 +38,6 @@ input:
type: file type: file
description: List of BAM files description: List of BAM files
pattern: "*.{bam}" pattern: "*.{bam}"
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -27,7 +27,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -46,11 +46,6 @@ input:
type: file type: file
description: Index for BAM/CRAM/SAM file description: Index for BAM/CRAM/SAM file
pattern: "*.{bai,crai,sai}" pattern: "*.{bai,crai,sai}"
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -28,7 +28,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -47,11 +47,6 @@ input:
type: file type: file
description: Index for BAM/CRAM/SAM file description: Index for BAM/CRAM/SAM file
pattern: "*.{bai,crai,sai}" pattern: "*.{bai,crai,sai}"
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -25,7 +25,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -40,11 +40,6 @@ input:
type: file type: file
description: BAM/CRAM/SAM file description: BAM/CRAM/SAM file
pattern: "*.{bam,cram,sam}" pattern: "*.{bam,cram,sam}"
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -25,7 +25,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -40,11 +40,6 @@ input:
type: file type: file
description: BAM/CRAM/SAM file description: BAM/CRAM/SAM file
pattern: "*.{bam,cram,sam}" pattern: "*.{bam,cram,sam}"
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -26,7 +26,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -45,11 +45,6 @@ input:
type: file type: file
description: Index for BAM/CRAM/SAM file description: Index for BAM/CRAM/SAM file
pattern: "*.{bai,crai,sai}" pattern: "*.{bai,crai,sai}"
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map

View file

@ -24,7 +24,7 @@ params:
description: | description: |
Value for the Nextflow `publishDir` mode parameter. Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move. Available: symlink, rellink, link, copy, copyNoFollow, move.
- conda: - enable_conda:
type: boolean type: boolean
description: | description: |
Run the module with Conda using the software specified Run the module with Conda using the software specified
@ -60,11 +60,6 @@ input:
description: | description: |
List of input FastQ files of size 1 and 2 for single-end and paired-end data, List of input FastQ files of size 1 and 2 for single-end and paired-end data,
respectively. respectively.
- options:
type: map
description: |
Groovy Map containing module options for passing command-line arguments and
output file paths.
output: output:
- meta: - meta:
type: map type: map