16S rRNA gene sequence curation and phylogenetic reference set creation
Python UnrealScript Shell
Permalink
Failed to load latest commit information.
bin
deenurp
docs
tests output_fp now required --output-seq Jun 16, 2016
.gitignore
.travis.yml travis doesn't run tests/run.sh Jun 10, 2016
CHANGES.rst
DEVELOPING.rst a few comments Dec 5, 2014
LICENSE.txt More packaging-related cleanup Sep 27, 2012
MANIFEST.in
README.rst Update README.rst Sep 2, 2016
deenurp.py
distribute_setup.py Bundle distribute; hack for multiprocessing bug Feb 4, 2013
requirements.txt
setup.py

README.rst

DeeNuRP

16S rRNA gene sequence curation and phylogenetic reference set creation

Installation

The Easy Way

  • confirm availability of necessary libraries to compile dependencies (on Ubuntu: sudo apt-get install gfortran libopenblas-dev liblapack-dev)
  • Install Python 2.7
  • run bin/bootstrap.sh
  • run source deenurp-env/bin/activate

the deenurp executable should now be on your $PATH

The Hard Way

See required system libraries above.

First, install binary dependencies:

Optional (for filter-outliers and pairwise-distances):

Finally, install:

python setup.py install

De-novo reference set creation

Similarity-search based reference sequence selection

Running

The deenurp package under the current directory provides to subcommands, accessed via the script deenurp.py, or the command deenurp if installed.

Subcommands fall into two general categories:

  • Building a set of reference sequences for use in refpkg building
  • Selecting sequences for a specific reference package

Creating a sequence set for refpkg building

deenurp filter-outliers

Removes outlier sequences from a reference database

deenurp expand-named

Expands poorly-represented names in a sequence file by similarity search

deenurp cluster-refs

Cluster reference sequences, first by tax-id at a specified rank (default: species), then by similarity for unnamed sequences or sequences not classified to the desired rank. Serves as input to search-sequences.

Selecting sequences for a reference package

deenurp hrefpkg-build

Builds a set of hierarchical reference packages.

deenurp search-sequences

Searches a set of sequences against a FASTA file containing possible reference sequences.

This subcommand does searches sequences against a reference FASTA file, saving the results and some metadata to a sqlite database for use in select-references

deenurp select-references

Given the output of search-sequences, select-references attempts to find a good set of reference sequences.

For each reference cluster with a minimal amount of sequences having best hits to the cluster, (see cluster-refs), selects a set number of sequences to serve as references.

deenurp fill-lonely

Taxa who are the sole descendent of their parent can complicate taxonomic classification.

The fill-lonely subcommand finds some company for these lonely taxa.

deenurp add-reps

Fetches sequences from a sequence file which match the taxtable for a reference set at a given rank. Useful for adding type strains.

deenurp tax2tree

Runs the tax2tree program on a reference package, updating the seq_info file.

Sequences whose lineage changes are relabeled. The prior tax_id is added to the seq_info file in the reference package.