mirror of
https://github.com/MillironX/nf-core_modules.git
synced 2024-12-23 03:28:17 +00:00
abe025677c
* updated kraken2 module to include optional classification of each input reads, and make fastq outputs optional NB: this is a breaking change, because the output channels have been renamed as a consequence of changes * updated yml * pigz command made optional, in order to be executed only if fastq of classified/unclassified reads are saved * updated test yaml file for kraken2 * fixed TODOs and renamed variables and outputs * untar in conda cannot keep same md5sum of version, and therefore md5sum check removed * improved description of the options Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
75 lines
2.1 KiB
YAML
75 lines
2.1 KiB
YAML
name: kraken2_kraken2
|
|
description: Classifies metagenomic sequence data
|
|
keywords:
|
|
- classify
|
|
- metagenomics
|
|
- fastq
|
|
- db
|
|
tools:
|
|
- kraken2:
|
|
description: |
|
|
Kraken2 is a taxonomic sequence classifier that assigns taxonomic labels to sequence reads
|
|
homepage: https://ccb.jhu.edu/software/kraken2/
|
|
documentation: https://github.com/DerrickWood/kraken2/wiki/Manual
|
|
doi: 10.1186/s13059-019-1891-0
|
|
licence: ["MIT"]
|
|
input:
|
|
- meta:
|
|
type: map
|
|
description: |
|
|
Groovy Map containing sample information
|
|
e.g. [ id:'test', single_end:false ]
|
|
- reads:
|
|
type: file
|
|
description: |
|
|
List of input FastQ files of size 1 and 2 for single-end and paired-end data,
|
|
respectively.
|
|
- db:
|
|
type: directory
|
|
description: Kraken2 database
|
|
- save_output_fastqs:
|
|
type: boolean
|
|
description: |
|
|
If true, optional commands are added to save classified and unclassified reads
|
|
as fastq files
|
|
- save_reads_assignment:
|
|
type: boolean
|
|
description: |
|
|
If true, an optional command is added to save a file reporting the taxonomic
|
|
classification of each input read
|
|
output:
|
|
- meta:
|
|
type: map
|
|
description: |
|
|
Groovy Map containing sample information
|
|
e.g. [ id:'test', single_end:false ]
|
|
- classified_reads_fastq:
|
|
type: file
|
|
description: |
|
|
Reads classified as belonging to any of the taxa
|
|
on the Kraken2 database.
|
|
pattern: "*{fastq.gz}"
|
|
- unclassified_reads_fastq:
|
|
type: file
|
|
description: |
|
|
Reads not classified to any of the taxa
|
|
on the Kraken2 database.
|
|
pattern: "*{fastq.gz}"
|
|
- classified_reads_assignment:
|
|
type: file
|
|
description: |
|
|
Kraken2 output file indicating the taxonomic assignment of
|
|
each input read
|
|
- report:
|
|
type: file
|
|
description: |
|
|
Kraken2 report containing stats about classified
|
|
and not classifed reads.
|
|
pattern: "*.{report.txt}"
|
|
- versions:
|
|
type: file
|
|
description: File containing software versions
|
|
pattern: "versions.yml"
|
|
authors:
|
|
- "@joseespinosa"
|
|
- "@drpatelh"
|