Skip to main content

BacterialTyper: a bioinformatics pipeline for the integrative analysis of bacterial WGS

Table of Contents

Introduction

We present BacterialTyper, a pipeline for the analysis of bacterial WGS data that integrates and facilitates the interpretation of results generated from multiple software analysis. It is capable of processing and identifying bacterial strains, identifying resistance and virulence genes, and generating data for outbreak analysis using WGS data from isolated microbial cultured colonies. The design of this bioinformatic tool allows comparing samples with an internal database (previously identified samples) and external databases.

The pipeline is written in Python with a modular architecture and based on open-source software and databases engines. Multiple tasks are performed by each of several modules including: preparation of raw data; assembly and annotation; bacterial strain identification; mobile genetic elements identification (plasmids, putative pathogenicity islands or phage insertions regions); generation of a virulence and resistance profile; clustering based on sequence similarity; phylogenetic analysis; integration of metadata, etc. The tool allows to compare samples with previously identified samples (collected and internal database) but it also uses, and updates periodically, external databases from different sources.

Workflow

Installation

To install BacterialTyper you need to create a conda environment with all dependendies requiere. In following weeks/months a stable conda recipe will be available.

We recommend using mamba to solve all dependencies and conflicts. To install mamba simply type in the base environemt:

## create environment and activate it
conda create -y -n BacterialTyper
conda activate BacterialTyper

## install mamba
conda install -c conda-forge mamba

Then, use mamba instead of conda to install further packages.

So far, you can either install BacterialTyper using:

  • a configuration file within this git repository (BacterialTyper/devel/conda/bacterialtyper-list.txt). See file here
  • or typing the following conda/mamba command:
mamba install -c r -c bioconda -c conda-forge \
  perl-bio-searchio-hmmer perl-bioperl \
  trimmomatic fastqc spades snippy prokka kma  \
  agrvate staphopia-sccmec kraken2 bowtie2  \
  ncbi-amrfinderplus bracken krakentools mlst

Finally, you will need to install BacterialTyper which is host in pypi here. Use pip and type:

pip install BacterialTyper

This will create a working installation of BacterialTyper and all dependencies.

Verify the configuration using

BacterialTyper config check

Documentation

For a full documentation and details visit Read the Docs site here.

License

MIT License

Copyright (c) 2020-2022 HCGB-IGTP

See additional details here

Citation

BacterialTyper was initially described in the ECCMID 2020 Poster [1]. See and example of usage in the characterization of some clinical samples [2].

[1] Sanchez-Herrero, J.; Lacoma, A.; Molina-Moya, B.; Giménez, M.; Molinos, S.; Prat, C.; Sumoy, L. BacterialTyper: A Bioinformatics Pipeline for the Integrative Analysis of Bacterial Whole Genome Sequencing. Abstract 1981. In Proceedings of the 30th European Congress of Clinical Microbiology and Infectious Diseases, Paris, France, 18–21 April 2020

[2] A. Lacoma et al., “Genotypic and Phenotypic Characterization of Staphylococcus aureus Isolates from the Respiratory Tract in Mechanically-Ventilated Patients,” Toxins (Basel)., vol. 13, no. 2, p. 122, Feb. 2021.

Metadata

Release files for BacterialTyper 0.6.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for BacterialTyper 0.6.7
File Size Uploaded Provenance Actions
BacterialTyper-0.6.7.tar.gz 683.4 kB Without provenance Details for BacterialTyper-0.6.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for BacterialTyper 0.6.7
File Interpreter ABI Platform Actions
BacterialTyper-0.6.7-py3-none-any.whl Python 3 none any Details for BacterialTyper-0.6.7-py3-none-any.whl

Total release size: 900.3 kB

Release files / BacterialTyper-0.6.7.tar.gz

Download URL BacterialTyper-0.6.7.tar.gz
Size 683.4 kB
Tags Source
SHA-256 checksum
How to use checksums
d160d8fd835b946d8abe7c4bcdf86c1939d12a76583a9071c387d5c125f30229
BLAKE2b-256 checksum
How to use checksums
db7dc854fd972c85c7df08bc1c58e389f40d6c761abeb64b92dc499369347242
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.31.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.2

Release files / BacterialTyper-0.6.7-py3-none-any.whl

Download URL BacterialTyper-0.6.7-py3-none-any.whl
Size 216.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
466201167315c64b156bb41a8a196a989069b7721add64d4199ad3a11b605e1a
BLAKE2b-256 checksum
How to use checksums
91ea750012987183a39324bd1995875a9ad0314d4562e07d8c7d9acc38b68132
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.31.0 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.2

Security for BacterialTyper 0.6.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page