nf-core/catpack/reads @ 0.0.0-6c4ed3a
Summary
Taxonomic classification plus read-based abundance estimation from long DNA sequences and metagenome assembled genomes (e.g. contigs, MAGs / bins).
Get started
Add the following snippet to your workflow script to include this module.
include { CATPACK_READS } from 'nf-core/catpack/reads'
License
MIT License
Name
|
CATPACK_READS |
|---|
meta
map
|
Groovy Map containing sample information e.g. |
|---|---|
reads
file
|
One or a pair of nucleotide FASTQ files (R1, R2) containing reads for mapping. Interleaved not supported. *.{fastq,fq,fastq.gz,fq.gz}
|
meta2
map
|
Groovy Map containing sample information e.g. |
|---|---|
contigs
file
|
A nucleotide FASTA file containing long DNA sequences such as contigs. Optional if *.{fasta,fna,fa,fas}
|
meta3
map
|
Groovy Map containing sample information e.g. |
|---|---|
database
directory
|
Directory containing CAT_pack database files (e.g. output from CAT_pack prepare) */
|
meta4
map
|
Groovy Map containing sample information e.g. |
|---|---|
taxonomy
directory
|
Directory containing CAT_pack taxonomy files (e.g. output from CAT_pack prepare) */
|
meta5
map
|
Groovy Map containing sample information e.g. |
|---|---|
bins
file
|
One or more nucleotide FASTA file containing binned long DNA sequences. Optional if *.{fasta,fna,fa,fas}
|
mode
string
|
Mode of operation of CAT_pack reads, "mcr": integrate annotations from MAGs (bins), contigs, and reads; "cr": integrate annotations from contigs and reads; "mr": integrate annotations from MAGs (bins) and reads. mcr|cr|mr
|
|---|
meta6
map
|
Groovy Map containing sample information e.g. |
|---|---|
bam_aligned
file
|
Optional pre-aligned and sorted reads mapped against contigs/bins. *.bam
|
meta7
map
|
Groovy Map containing sample information e.g. |
|---|---|
bam_unaligned
file
|
Optional sorted unaligned reads from mapping against contigs/bins. *.bam
|
meta8
map
|
Groovy Map containing sample information e.g. |
|---|---|
contig2classification
file
|
Optional TSV file with per-contig hit stats and assignment justification information *.contig2classification.txt
|
meta9
map
|
Groovy Map containing sample information e.g. |
|---|---|
bin2classification
file
|
Optional TSV file with per-bin hit stats and assignment justification information *.bin2classification.txt
|
meta10
map
|
Groovy Map containing sample information e.g. |
|---|---|
unclassified2classification
file
|
Optional TSV file with pre-made CAT_pack reads unmapped2classification.txt file information *.txt
|
meta11
map
|
Groovy Map containing sample information e.g. |
|---|---|
proteins
directory
|
Optional pre predicted-made proteins FASTA *.{fasta,faa,fa,fas}
|