Skip to content

Latest commit

Β 

History

37 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MDHHS-Bioinformatics/BaSSeT MDHHS-Bioinformatics/BaSSeT

🧬 BaSSeT

Nextflow run with docker run with singularity run with apptainer License: MIT GitHub release Last Commit DOI

BaSSeT (Bacterial Species-Specific Typing) is a bioinformatics pipeline for species-specific typing of bacteria. It takes a samplesheet with reads (FASTQ) and assembly (FASTA) files of multiple isolates from different organisms; performs species-specific typing analysis, produces a summary report per batch and combines new and prior results into a master results file.

Suggested workflow

BaSSeT is designed to analyze QC-trimmed reads and genome assemblies generated by sequencing pipelines such as PHoeNIx, Bactopia, TheiaProk, custom workflows, or retrieved from public databases such as AllTheBacteria and NCBI. The pipeline provides species-specific predictions for serotyping or serogrouping, virulence gene detection, and other analyses that complement higher-resolution typing approaches such as MLST and cgMLST. These outputs can support epidemiological investigations and genomic population analyses.

BaSSeT is not intended to be an end-to-end read QC or assembly pipeline. Instead, it is designed to avoid duplicating upstream quality-control steps while providing a portable and reproducible framework for typing diverse bacterial organisms.

🌟 Highlights

  • 🦠 Processes multiple organisms in parallel
  • 🧬 Supports 24 different typing analyses
  • πŸ“„ Generates summary results with tool versions per batch
  • πŸ“„ New and prior results are appended to a master file

πŸ“Š Workflow Overview

High-level steps:

  1. Input check
  2. ABRicate if --abricate_db <database> specified
  3. Species specific analyses
  4. Batch summary generation
  5. Master summary generation

For full workflow details check Workflow documentation


πŸš€ Usage

1️⃣ Requirements

2️⃣ Prepare samplesheet

Prepare a samplesheet (CSV) to define sample files and organisms:

sample,fastq_1,fastq_2,assembly,organism
SAMPLE_1,/path/S1_R1.fastq.gz,/path/S1_R2.fastq.gz,/path/S1.fasta,Escherichia_coli
SAMPLE_2,/path/S2_R1.fastq.gz,/path/S2_R2.fastq.gz,/path/S2.fasta,Salmonella
SAMPLE_3,/path/S3.fastq.gz,,/path/S3.fasta,Shigella
SAMPLE_4,,,/path/S4.fasta,Pseudomonas_aeruginosa
SAMPLE_5,/path/S5_R1.fastq.gz,/path/S5_R2.fastq.gz,/path/S5.fasta,Legionella_pneumophila

Input format description

Column Description
sample Unique sample ID
fastq_1 Path to trimmed read 1 (leave empty if not available)
fastq_2 Path to trimmed read 2 (leave empty for single-end, ONT or assemblies)
assembly FASTA assembly
organism Supported organism name (can be Other if running ABRicate for any other species)

Important

  • Most analyses require assemblies as input. However, tools such as el_gato and SeqSero2 may provide more accurate results when reads are supplied.
  • Reads are required for ShigaTyper, SeroBA, and ARIBA. If reads are not provided for a sample, these analyses will be skipped for that sample.

Note

If the reads are from ONT, add the flag --ont when running your analyses. ONT reads are only supported for ECTyper, SeqSero2, and ShigaTyper

Supported inputs per tool

Organism Tool Aim fastq1 fastq2 Assembly
Acinetobacter baumannii Kaptive with Wyres et. al database Serotyping based on K and OC antigens - - βœ”οΈ
Escherichia coli ECTyper Serotyping based on O/H antigens; optional pathotyping (only when using --ecoli_pathotypes) Fallback ⚠️ (only when ONT) - Preferred βœ”οΈ
Haemophilus influenzae HICap Serotyping based on cap locus (a–f) - - βœ”οΈ
Klebsiella pneumoniae complex Kleborate Serotyping (K/O), MLST, virulence genes - - βœ”οΈ
Legionella pneumophila el_gato Sequence‑based typing (SBT) Preferred βœ”οΈ Preferred βœ”οΈ Fallback ⚠️
Legionella pneumophila ABRicate with ReporType databases O‑antigen serogrouping (wzm/wzt) and subsepcies - - βœ”οΈ
Listeria monocytogenes LisSero Serogrouping/serotyping (O/H) - - βœ”οΈ
Neisseria gonorrhoeae NGMASTER porB/tbpB typing; AMR typing - - βœ”οΈ
Neisseria meningitidis meningotype Serogrouping (capsule); MLST; BAST; MenDeVAR - - βœ”οΈ
Pseudomonas aeruginosa Pasty Serotyping based on O antigen - - βœ”οΈ
Salmonella SeqSero2 Serotyping and antigenic profile Preferred βœ”οΈ (can be ONT) Preferred βœ”οΈ (optional for single-end or ONT) Fallback ⚠️
Salmonella SISTR Serovar prediction via antigen genes + cgMLST - - βœ”οΈ
Shigella ShigaTyper Serotyping + ipaB βœ”οΈ (can be ONT) βœ”οΈ (optional for single-end or ONT) -
Shigella ShigEiFinder Shigella/EIEC diff.; serotyping; virulence plasmid Fallback ⚠️ Fallback ⚠️ Preferred βœ”οΈ
Staphylococcus aureus AgrVATE agr locus typing - - βœ”οΈ
Staphylococcus aureus sccmec SCCmec cassette typing - - βœ”οΈ
Staphylococcus aureus spaTyper spa repeat typing - - βœ”οΈ
Streptococcus dysgalactiae emmtyper emm type assignment - - βœ”οΈ
Streptococcus pneumoniae pbptyper PBP typing - - βœ”οΈ
Streptococcus pneumoniae SeroBA Serotyping via cps locus βœ”οΈ βœ”οΈ -
Streptococcus pyogenes emmtyper emm type assignment - - βœ”οΈ
Vibrio parahaemolyticus Kaptive with Zomer Lab databases K/O serotyping - - βœ”οΈ
Vibrio cholerae ARIBA Detect ctxA, ctxB, tcpA, rstR βœ”οΈ βœ”οΈ -
Vibrio cholerae Kaptive with VicPred OAGC database O‑antigen serotyping - - βœ”οΈ
Other (and any supported organism) ABRicate Locus detection, any db via --abricate_db - - βœ”οΈ

ABRicate bundles multiple databases for the detection of resistance determinants and virulence factors. This tool is optional and available for any organism in the sample sheet when using --abricate_db <database>. Only one database can be used per run:

Database Description Gene Types
argannot Antibiotic resistance gene annotation AMR genes
bacmet2 Bacterial biocide & metal resistance genes Metal/biocide resistance
card Comprehensive Antibiotic Resistance Database AMR genes
ecoh E. coli virulence genes (subset) Virulence factors
ecoli_vf Expanded E. coli virulence gene set Virulence factors
megares Antibiotic resistance ontology AMR genes
ncbi NCBI AMRFinder+ gene set AMR genes
plasmidfinder Plasmid replicon typing Plasmid replicons
resfinder Resistance gene detection AMR genes
upec_expec_vf UPEC/ExPEC virulence markers Virulence factors
vfdb Virulence Factor Database Virulence genes
victors Bacterial virulence database Virulence genes

3️⃣ Run

Now, you can run the pipeline using:

nextflow run MDHHS-Bioinformatics/basset \
  -profile apptainer \
  --input samplesheet.csv \
  --outdir basset_results

For advance run including species-specific analyses and ABRicate:

nextflow run MDHHS-Bioinformatics/basset \
  -profile apptainer \
  --input samplesheet.csv \
  --outdir basset_results \
  --abricate_db vfdb \
  --ecoli_pathotypes \
  --max_memory 50.GB \
  --max_cpus 8 \
  --max_time 4.h

For more details and further functionality, please refer to Usage documentation and the Parameter documentation

πŸ“‚ Outputs

Results are organized by organism except by the ABRicate results:

πŸ“ <outdir>/
β”œβ”€β”€ πŸ“ <Organism>/
|    └── πŸ“„<sample>_<tool>_<out_name>.tsv
|    └── πŸ“„<sample>_<tool>_summary.tsv
β”œβ”€β”€ πŸ“ abricate/  (only if --abricate_db <database>)
|    └── πŸ“„<sample>_abricate_<db>.tsv
β”œβ”€β”€ πŸ“„basset_summary_batch.tsv
└── πŸ“„basset_summary_master.tsv

Key outputs:

  • BaSSeT summary batch
  • BaSSeT summary master

For more details about the output files and reports, please refer to the Output documentation

πŸ‘₯ Credits

BaSSeT was built and is maintained by the Genomic Analysis Unit at the Michigan Department of Health & Human Services (MDHHS) Bureau of Laboratories. This pipeline was developed by Karla Vasco using the nf-core template.

Additional conceptual guidance and scientific input were provided by Arianna Miles-Jay and Heather Blankenship.

🀝 Contributions

Contributions, issues, and pull requests are welcome! If you would like to contribute to this pipeline, please see the Contribution guidelines.

πŸ“š Citations

If you use BaSSeT for your analysis, please cite the following doi:

Vasco K., Blankenship H. & Miles-Jay A. (2026). MDHHS-Bioinformatics/basset: v1.0.0 (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.20856443

An extensive list of references for the tools used by the pipeline can be found in CITATIONS.md.

⚠️ Disclaimer

This repository is not a source of government records but is intended to increase collaboration and collaborative potential on public health related projects. Materials and information in this repository are intended to share information and collaboratively develop analysis workflows.

The workflows and pipelines reflect the current understanding of the software and biological questions being answered and may be updated as needed and pursuant to further analysis and review. No warranty, expressed or implied, is made by MDHHS Bureau of Laboratories as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. Furthermore, the software is released on condition that the MDHHS Bureau of Laboratories shall not be held liable for any damages resulting from its authorized or unauthorized use.

πŸ”’ Privacy Notice

Use of this service is limited only to non-sensitive and publicly available data. Users must not use, share, or store any kind of sensitive data like health status, provision or payment of healthcare, Personally Identifiable Information (PII) and/or Protected Health Information (PHI), etc. under any circumstance.

πŸ“œ License

This project is released under the MIT License.

About

Nextflow pipeline for species-specific typing of bacteria

Topics

Resources

Code of conduct

Contributing

Stars

9 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages