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.3.tar.gz (6.4 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: xspect-0.2.3.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.3.tar.gz
Algorithm Hash digest
SHA256 471c3fbf668b5ce047ebbabdfed4b5f701cf6e73c4c54a82111692e73e7d256f
MD5 6fa40dfe4bb421729ff1ab0d77e9155b
BLAKE2b-256 ceb694889580f5df849302d98854e8483513241fa0ac5b11ddb4c8d6f5f54de8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: XspecT-0.2.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ad723d5d5800be8d095d8adc55254f85be12985f5c8c1d5e2da3819b62429f9d
MD5 0734687da0f996d9578f81e319c5c505
BLAKE2b-256 fb7b1a9c0f9f406748e3e5900adac2b0ab35c32b7a2531d16b3fd8b940fd0d51

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