nf-core_modules/modules/gtdbtk/classifywf/meta.yml
Abhinav Sharma 3868c3ab4b
Add gtdbtk/classifywf module (#765)
* initial commit [ci skip]

* reuse the modules code from nf-core/mag [ci skip]

* add contextual information for the module [ci skip]

* add stubs to avoid downloading db [ci skip]

* trigger test

* iterate on tests [ci skip]

* itereate tests [ci skip]

* add bins [ci skip]

* fix stubs [ci skip]

* interation on tests with stubs [ci skip]

* use the existing pattern and fasta for input

* accomodate the new version file format

* use variable for the stub [ci skip]

* update the versions file in meta.yml

* Accomodate code review regarding publishDir function [ci skip]

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>

* remove extra newline

* use bioconda channel

* update the description for filtered file

* Apply suggestions from code review

* Update main.nf

* Update main.nf

* Update modules/gtdbtk/classifywf/meta.yml

Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>

Co-authored-by: Robert A. Petit III <robbie.petit@gmail.com>
Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com>
2021-10-05 21:23:01 +01:00

78 lines
2.6 KiB
YAML

name: gtdbtk_classifywf
description: GTDB-Tk is a software toolkit for assigning objective taxonomic classifications to bacterial and archaeal genomes based on the Genome Database Taxonomy GTDB.
keywords:
- GTDB taxonomy
- taxonomic classification
tools:
- gtdbtk:
description: GTDB-Tk is a software toolkit for assigning objective taxonomic classifications to bacterial and archaeal genomes based on the Genome Database Taxonomy GTDB.
homepage: https://ecogenomics.github.io/GTDBTk/
documentation: https://ecogenomics.github.io/GTDBTk/
tool_dev_url: https://github.com/Ecogenomics/GTDBTk
doi: "10.1093/bioinformatics/btz848"
licence: ['GNU General Public v3 (GPL v3)']
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false, assembler:'spades' ]
- bins:
type: The binned fasta files from the assembler
description: Fasta files
pattern: "*.{fasta,fa}"
- database:
type: The local copy of the taxonomic database used by GTDB-tk
description: The unzipped copy of the database
pattern: "*"
output:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- versions:
type: file
description: File containing software versions
pattern: "versions.yml"
- summary:
type: file
description: A TSV summary file for the classification
pattern: "*.{summary.tsv}"
- tree:
type: file
description: NJ or UPGMA tree in Newick format produced from a multiple sequence alignment
pattern: "*.{classify.tree.gz}"
- markers:
type: file
description: A TSV summary file lineage markers used for the classification.
pattern: "*.{markers_summary.tsv}"
- msa:
type: file
description: Multiple sequence alignments file.
pattern: "*.{msa.fasta.gz}"
- user_msa:
type: file
description: Multiple sequence alignments file for the user-provided files.
pattern: "*.{user_msa.fasta.gz}"
- filtered:
type: file
description: A list of genomes with an insufficient number of amino acids in MSA..
pattern: "*.{filtered.tsv}"
- log:
type: file
description: GTDB-tk log file
pattern: "*.{log}"
- warnings:
type: file
description: GTDB-tk warnings log file
pattern: "*.{warnings.log}"
- failed:
type: file
description: A TSV summary of the genomes which GTDB-tk failed to classify.
pattern: "*.{failed_genomes.tsv}"
authors:
- "@skrakau"
- "@abhi18av"