spoligotyper 0.4.2

In silico spoligotyping of Mycobacterium tuberculosis complex (MTBC) samples, from sequencing reads (fastq) or genome assemblies (fasta). spoligotyper finds the 43 spacers of the direct repeat (DR) locus with Seal from BBTools and reports the spoligotype as binary, octal and hexadecimal codes, and as an SB number from the Mbovis.org database. It also identifies the species and the lineage, and flags contaminated or mixed samples.

_{PDF report of the tutorial: summary, and the evidence for each sample. Full example report (PDF).}

Features

• Reads or assemblies: single-end or paired-end fastq, or fasta, gzipped or not. For nanopore data, type the assembly (why).
• Batch mode: point it at a folder; fastq and fasta files are detected and R1/R2 files paired automatically.
• All the standard codes: binary, octal, hexadecimal, and SB number for M. bovis and other animal-adapted lineages.
• Species and lineage: M. tuberculosis, M. africanum, M. bovis, BCG, ... from regions of difference, and the lineage (1 to 7 and sublineages) from a 62-SNP barcode.
• Quality checks: fraction of MTBC reads (contamination), mixed samples, consistency between the spoligotype, species and lineage, and the closest known patterns for new spoligotypes.
• PDF report for QA: results, reads supporting each spacer, input files with checksums, software versions, parameters, operator, date, and a review box. Plus a table, JSON and a MultiQC section for pipelines.
• Validated on 16 reference genomes and 8 read sets of known species, lineage and spoligotype (Validation).
• Workflow ready: nf-core module and Galaxy tool in integrations/.
• Transparent: borderline calls, low depth and failed samples are flagged, never hidden.
• Fast: a few seconds per sample, with 1 GB of memory.

Installation

conda install -c conda-forge -c bioconda spoligotyper

Or with pip, if BBTools is already installed (conda install -c bioconda bbmap): pip install spoligotyper. See Installation for other options.

Quick start

spoligotyper -r1 sample_R1.fastq.gz -r2 sample_R2.fastq.gz -o results/   # Paired-end reads
spoligotyper -r1 sample.fastq.gz -o results/                             # Single-end reads
spoligotyper -r1 assembly.fasta -o results/                              # Assembly (also for nanopore data)
spoligotyper -i folder/ -o results/                                      # All the samples in a folder

The results are printed and saved in results/ as a table and a PDF report. New to the tool? The tutorial types three public genomes in a few minutes.

Documentation

The wiki covers usage and options, output files, how it works, species and lineage, validation, troubleshooting and the FAQ.

Citing

If you use spoligotyper, please cite it and BBTools, which finds the spacers:

Duceppe M-O. spoligotyper: in silico spoligotyping of Mycobacterium tuberculosis complex genomes. Zenodo. https://doi.org/10.5281/zenodo.22926160

This DOI always points to the latest version; each release also has its own DOI, listed on Zenodo. GitHub's "Cite this repository" button gives the same citation in APA and BibTeX formats.

Bushnell B. BBTools. https://sourceforge.net/projects/bbmap/

For the lineage, please also cite the SNP barcode:

Coll F et al. A robust SNP barcode for typing Mycobacterium tuberculosis complex strains. Nat Commun 5, 4812 (2014). https://doi.org/10.1038/ncomms5812

Contributing

Bug reports, questions and pull requests are welcome: see CONTRIBUTING.md.

Author

Marc-Olivier Duceppe, Canadian Food Inspection Agency (CFIA): marc-olivier.duceppe@inspection.gc.ca

License

MIT