Skip to main content

Tool to monitor and characterize pathogens using Bloom filters.

Project description

XspecT - Acinetobacter Species Assignment Tool

Test linting: pylint Code style: black

XspecT is a Python-based tool to taxonomically classify sequence-reads (or assembled genomes) on the species and/or sub-type level using [Bloom Filters] and a [Support Vector Machine]. It also identifies existing [blaOxa-genes] and provides a list of relevant research papers for further information.

XspecT utilizes the uniqueness of kmers and compares extracted kmers from the input-data to a reference database. Bloom Filter ensure a fast lookup in this process. For a final prediction the results are classified using a Support Vector Machine.

Local extensions of the reference database are supported.

The tool is available as a web-based application and a smaller command line interface.

Installation

To install Xspect, please download the lastest 64 bit Python version and install the package using pip:

pip install xspect

Please note that Apple Silicon is currently not supported.

Usage

Get the Bloomfilters

To download basic pre-trained filters, you can use the built-in command:

xspect download-filters

Additional species filters can be trained using:

xspect train you-ncbi-genus-name

How to run the web app

To run the web app, install and run XspecT Web. Additionally, run XspecT in API mode:

xspect api

How to use the XspecT command line interface

Run xspect with the configuration you want to run it with as arguments.

xspect classify your-genus path/to/your/input-set

For further instructions on how to use the command line interface, please refer to the documentation or execute:

xspect --help

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

xspect-0.2.0.tar.gz (6.4 MB view details)

Uploaded Source

Built Distribution

XspecT-0.2.0-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file xspect-0.2.0.tar.gz.

File metadata

  • Download URL: xspect-0.2.0.tar.gz
  • Upload date:
  • Size: 6.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for xspect-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d3300caeec5927155700459fb94acb11ab9fe09eeebad9d3de5824dc5b982f0a
MD5 739bf10dc16f8e0d42ac4c3963177177
BLAKE2b-256 188d71aaf1c1bfdcaea62b6bb4328c33959055ec54ce12d7b81072630c1d084d

See more details on using hashes here.

File details

Details for the file XspecT-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: XspecT-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for XspecT-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2cd126ad6c6ece6d54f75eef8e95353681c8ccb1bd593a7890ff15b2e4aba6b
MD5 15e88639ecb6b49668f81c0dee57e414
BLAKE2b-256 274d31d9cf1c96a73aa6657e9e334e285e6e86970ba1a1e7325d458538c068e7

See more details on using hashes here.

Supported by

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