Skip to main content

bactopia_sketcher

Tags: bacteria taxonomy classification minhash sketch mash sourmash refseq gtdb sample-scope

Create genomic sketches and perform rapid taxonomic classification.

Uses Mash and Sourmash to create MinHash sketches of the input sequences. These sketches are then queried against pre-built databases (RefSeq and GTDB to identify the closest reference genomes.

Databases Required

Requires the pre-compiled RefSeq (Mash) and GTDB (Sourmash) databases, usually downloaded by the datasets module.

Inputs

record (
meta: Record,
fna: Path
)
FieldTypeDescription
metaRecordGroovy Record containing sample information
fnaPathAssembled contigs in FASTA format
mash_db: Path
sourmash_db: Path
NameTypeDescription
mash_dbPathPath to the Mash RefSeq database
sourmash_dbPathPath to the Sourmash GTDB LCA database

Outputs

record (
meta: Record,
sig: Path,
msh: Set<Path>,
mash: Path,
sourmash: Path,
results: Set<Path>,
logs: Set<Path?>,
nf_logs: Set<Path>,
versions: Set<Path>
)
FieldTypeDescription
metaRecordSample information record
sigPathThe Sourmash signature file (*.sig)
mshSet<Path>The Mash sketch files for k=21 and k=31 (*.msh)
mashPathA classification report of Mash Screen results against RefSeq database
sourmashPathA classification report from Sourmash LCA against GTDB database
resultsSet<Path>All output files to be published
logsSet<Path?>Optional program specific log files
nf_logsSet<Path>Nextflow-specific log files (e.g. .command.{begin
versionsSet<Path>A YAML formatted file with program versions

Parameters

Used By

Subworkflows

  • bactopia_sketcher - Create genomic sketches and perform rapid taxonomic classification.

Workflows

  • bactopia - Comprehensive bacterial analysis pipeline for complete genomic characterization.
  • staphopia - Comprehensive analysis pipeline for Staphylococcus aureus isolates.

Citations

If you use this in your analysis, please cite the following.

Source

View source on GitHub

Version

BACTOPIA_SKETCHER:
- bactopia-sketcher: 1.0.3