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 Windows and Alpine Linux 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.5.tar.gz (6.4 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xspect-0.2.5.tar.gz
Algorithm Hash digest
SHA256 0ac2c32b9beba32f9dca0e62292f8df66e4ff256762a7e62bdd58c7b63add1c4
MD5 90fa83863ed9403120f026377dfbc065
BLAKE2b-256 7516ce3fdd8ad570a9e8df6e0225ecd39dc67f102afbb69417d597c0f67b6362

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for XspecT-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 66c7587ee3d9e1391ef4e29f3d735ad067677907d5797df324a88fb9efafeca3
MD5 83290746f146af04bae96ff83f24c316
BLAKE2b-256 92a38c215839abd9c6ea090b2525a94a4efd5f145ca5109b4d5436313eb410eb

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