Skip to main content

ProPhyle metagenomic classifier

Project description

https://travis-ci.org/karel-brinda/prophyle.svg?branch=master https://readthedocs.org/projects/prophyle/badge/?version=latest https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat-square https://badge.fury.io/py/prophyle.svg

Introduction

ProPhyle is a k-mer based metagenomic classifier using Burrows-Wheeler Transform. Its indexing strategy relies on a bottom-up propagation of k-mers in the tree, assembling contigs at each node, and matching using a standard full-text search using BWT-index. The analysis of shared k-mers between NGS reads and the genomes in the index determines which nodes are the best candidates for their classification. More information about the indexing scheme can be found in our poster.

Compared to other state-of-the-arts classifiers, ProPhyle provides several unique features:

  • Low memory requirements. Compared to Kraken, ProPhyle has 9x smaller memory footprint for index construction and 5x smaller footprint for querying.

  • Flexibility. ProPhyle is easy to use with any user-provided phylogenetic trees and reference genomes.

  • Standard bioinformatics formats. Newick/NHX is used for representing phylogenetic trees and SAM for reporting the assignments.

  • Lossless k-mer indexing. ProPhyle stores a list of all genomes containing a k-mer. It can be, therefore, accurate even with trees containing similar genomes (e.g, phylogenetic trees for a single species).

  • Deterministic behavior. ProPhyle is a fully deterministic classifier with a mathematically well-defined behavior.

For information about how to use ProPhyle, see the main ProPhyle documentation.

Quick example

  1. Clone the ProPhyle repository and add it to PATH:

    git clone --recursive http://github.com/karel-brinda/prophyle
    export PATH=$(pwd)/prophyle/prophyle:$PATH
  2. Download the RefSeq bacterial database:

    $ prophyle download bacteria
  3. To quickly test ProPhyle functionality, create an index for randomly sampled 10% genomes from the E.coli subtree of NCBI taxonomy (with k=31):

    $ prophyle index -s 0.1 ~/prophyle/bacteria.nw@561 _index_ecoli
  4. Classify your reads:

    $ prophyle classify _index_ecoli reads.fq > result.sam

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

prophyle-0.2.1.2.tar.gz (1.7 MB view hashes)

Uploaded Source

Built Distribution

prophyle-0.2.1.2-py3-none-any.whl (1.8 MB view hashes)

Uploaded Python 3

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