mirror of
https://github.com/MillironX/nf-core_modules.git
synced 2024-12-22 19:18:17 +00:00
Update docs
This commit is contained in:
parent
cb08a7326a
commit
0466d5249b
1 changed files with 15 additions and 25 deletions
|
@ -1,4 +1,4 @@
|
||||||
name: FastQC
|
name: fastqc
|
||||||
description: Run FastQC on sequenced reads
|
description: Run FastQC on sequenced reads
|
||||||
keywords:
|
keywords:
|
||||||
- Quality Control
|
- Quality Control
|
||||||
|
@ -15,37 +15,27 @@ tools:
|
||||||
homepage: https://www.bioinformatics.babraham.ac.uk/projects/fastqc/
|
homepage: https://www.bioinformatics.babraham.ac.uk/projects/fastqc/
|
||||||
documentation: https://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/
|
documentation: https://www.bioinformatics.babraham.ac.uk/projects/fastqc/Help/
|
||||||
params:
|
params:
|
||||||
- fastqc_args:
|
- outdir:
|
||||||
type: string
|
|
||||||
description: Additional command line arguments passed to fastqc.
|
|
||||||
- out_dir:
|
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
The pipeline's output directory. By default, the module will
|
The pipeline's output directory. By default, the module will
|
||||||
output files into `$out_dir/MODULE_NAME`
|
output files into `$params.outdir/<SOFTWARE>`
|
||||||
- publish_dir:
|
|
||||||
type: string
|
|
||||||
description: |
|
|
||||||
Append to the path for the standard output directory provided by `$out_dir`.
|
|
||||||
- publish_dir_mode:
|
- publish_dir_mode:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
Provide a value for the Nextflow `publishDir` mode parameter
|
Value for the Nextflow `publishDir` mode parameter.
|
||||||
(e.g. copy, link, ...)
|
Available: symlink, rellink, link, copy, copyNoFollow, move.
|
||||||
- publish_results:
|
- conda:
|
||||||
type: string
|
|
||||||
description: |
|
|
||||||
Whether or not to publish results into `publish_dir`. Set to `none` to not
|
|
||||||
publish any files at all; to `default` to publish all relevant files.
|
|
||||||
input:
|
|
||||||
- name:
|
|
||||||
type: string
|
|
||||||
description: Sample identifier
|
|
||||||
- single_end:
|
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |
|
description: |
|
||||||
Boolean indicating whether the corresponding sample is single-end (true)
|
Run the module with Conda using the software specified
|
||||||
or paired-end (false).
|
via the `conda` directive
|
||||||
|
input:
|
||||||
|
- meta:
|
||||||
|
type: map
|
||||||
|
description: |
|
||||||
|
Groovy Map containing sample information
|
||||||
|
e.g. [ id:'test', single_end:false ]
|
||||||
- reads:
|
- reads:
|
||||||
type: file
|
type: file
|
||||||
description: |
|
description: |
|
||||||
|
@ -57,7 +47,7 @@ output:
|
||||||
description: FastQC report
|
description: FastQC report
|
||||||
pattern: "*_fastqc.{zip,html}"
|
pattern: "*_fastqc.{zip,html}"
|
||||||
authors:
|
authors:
|
||||||
- "@grst"
|
|
||||||
- "@drpatelh"
|
- "@drpatelh"
|
||||||
|
- "@grst"
|
||||||
- "@ewels"
|
- "@ewels"
|
||||||
- "@FelixKrueger"
|
- "@FelixKrueger"
|
||||||
|
|
Loading…
Reference in a new issue