Skip to main content

A complete suite for gene-by-gene schema creation and strain identification.

Project description

PyPI Bioconda Conda chewBBACA Documentation Status License: GPL v3 DOI:10.1099/mgen.0.000166

chewBBACA

chewBBACA is a software suite for the creation and evaluation of core genome and whole genome MultiLocus Sequence Typing (cg/wgMLST) schemas and results. The "BBACA" stands for "BSR-Based Allele Calling Algorithm". BSR stands for BLAST Score Ratio as proposed by Rasko DA et al.. The "chew" part adds extra coolness to the name and could be thought of as "Comprehensive and Highly Efficient Workflow". chewBBACA allows to define the target loci in a schema based on multiple genomes (e.g. define target loci based on the distinct loci identified in a dataset of high-quality genomes for a species or lineage of interest) and performs allele calling to determine the allelic profiles of bacterial strains, easily scaling to thousands of genomes with modest computational resources. chewBBACA includes functionalities to annotate the schema loci, compute the set of loci that constitute the core genome for a given dataset, and generate interactive reports for schema and allele calling results evaluation to enable an intuitive analysis of the results in surveillance and outbreak detection settings or population studies. Pre-defined cg/wgMLST schemas can be downloaded from Chewie-NS or adapted from other cg/wgMLST platforms.

Check the documentation for implementation details and guidance on using chewBBACA.

News

3.5.4 - 2026-04-22

This release adds the following bug fixes:

  • The file with the cgMLST MSA was missing from the output directory created by the AlleleCallEvaluator module since the release of the ComputeMSA module (thanks to @victor5lm who reported this issue in https://github.com/B-UMMI/chewBBACA/issues/235). This change was unintended. The file with cgMLST MSA was re-added as one of the output files from the AlleleCallEvaluator module (protein_msa.fasta file). Simplified the conditions used to determine which steps to run.
  • Made the definition of the sequence headers for the adapted schemas created by the PrepExternalSchema less rigid to better deal with unexpected headers. Added tests to validate schema adaptation for multiple external schema formats (e.g., EnteroBase, PubMLST, and Ridom).
  • Fixed the parsing of the file with loci annotations in the LoadSchema module.
  • Fixed the creation of the paths to intermediate FASTA files used by BLASTp to determine representative alleles during schema adaptation. The paths were not properly created when the SyncSchema module called the PrepExternalSchema module using relative paths.
  • Changed the index value used by the select_highest_scores function to sort and select the highest scoring BLASTp matches per target from 5 to 6. The results were being sorted based on the length of the target sequences instead of the alignment raw score. This issue would not allow to identify the best scoring alignment in some cases, potentially leading to some sequences not being classified if a lower scoring alignment was selected. Fixing this issue results in a slight increase in the accuracy of the allele calling (thanks to @andreaderuvo for reporting this issue in https://github.com/B-UMMI/chewBBACA/issues/234).

Check our Changelog to learn more about the latest changes.

Citation

When using chewBBACA, please use the following citation:

Silva M, Machado MP, Silva DN, Rossi M, Moran-Gilad J, Santos S, Ramirez M, Carriço JA. 2018. chewBBACA: A complete suite for gene-by-gene schema creation and strain identification. Microb Genom 4:000166. doi:10.1099/mgen.0.000166

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chewbbaca-3.5.4.tar.gz (10.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chewbbaca-3.5.4-py3-none-any.whl (11.0 MB view details)

Uploaded Python 3

File details

Details for the file chewbbaca-3.5.4.tar.gz.

File metadata

  • Download URL: chewbbaca-3.5.4.tar.gz
  • Upload date:
  • Size: 10.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.13

File hashes

Hashes for chewbbaca-3.5.4.tar.gz
Algorithm Hash digest
SHA256 589861c606282fdc4a0bfd3112b881e62a5a92b59e739974dda50a478fa92706
MD5 58b888ab956b12afc00875ce25604d59
BLAKE2b-256 3c6fee50c6c22148b859483abe51d06ef11b44782bb6e92156aa598c63832ad1

See more details on using hashes here.

File details

Details for the file chewbbaca-3.5.4-py3-none-any.whl.

File metadata

  • Download URL: chewbbaca-3.5.4-py3-none-any.whl
  • Upload date:
  • Size: 11.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.13

File hashes

Hashes for chewbbaca-3.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 40c85c886770c2eb5f0e85cf18564c44728541c2addbb5f0c9bdabc0e9921025
MD5 9ae40005b3da109bf1eb8d448e7eaa49
BLAKE2b-256 ce45df3f3b7228ee1883ce040205862a2c60759d3459d101f2557c9ed278aba6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page