Skip to content
Robust Aitchison PCA from sparse count data
Python Other
  1. Python 99.0%
  2. Other 1.0%
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci fixing bootstrap numpy issues Jan 16, 2019
deicode
ipynb
.coveragerc
.gitattributes trying tp fix linguist Oct 23, 2018
.gitignore MAINT: Abstract OrdinationResults checking to func Apr 6, 2019
.travis.yml dumb conda Oct 15, 2019
CHANGELOG.md
COPYING.txt QIIME error (#22) Feb 8, 2019
MANIFEST.in adding makefile for pip May 10, 2017
Makefile TST: Add Makefile with "make test" Apr 9, 2019
README.md update tests, comments, chnagelog, some structure Jun 18, 2019
setup.py REL: Reference DEICODE citation in Q2 plugin Apr 3, 2019

README.md

Build Status Coverage Status

DEICODE is a tool box for running Robust Aitchison PCA on sparse compositional omics datasets, linking specific features to beta-diversity ordination.

Installation

To install the most up to date version of deicode, run the following command

# pip (only supported for QIIME2 >= 2018.8)
pip install deicode

# conda (only supported for QIIME2 >= 2019.1)
conda install -c conda-forge deicode 

Note: that deicode is not compatible with python 2, and is compatible with Python 3.4 or later. deicode is currently in alpha. We are actively developing it, and backward-incompatible interface changes may arise.

Using DEICODE as a standalone tool

$ deicode --help
Usage: deicode [OPTIONS]

  Runs RPCA with an rclr preprocessing step.

Options:
  --in-biom TEXT               Input table in biom format.  [required]
  --output-dir TEXT            Location of output files.  [required]
  --n_components INTEGER       The underlying low-rank structure (suggested: 1
                               < rank < 10) [minimum 2]  [default: 3]
  --min-sample-count INTEGER   Minimum sum cutoff of sample across all
                               features  [default: 500]
  --min-feature-count INTEGER  Minimum sum cutoff of features across all
                               samples  [default: 10]
  --max_iterations INTEGER         The number of iterations to optimize the
                               solution (suggested to be below 100; beware of
                               overfitting) [minimum 1]  [default: 5]
  --help                       Show this message and exit.

Using DEICODE inside QIIME 2

  • The QIIME2 forum tutorial can be found here.
  • The official plugin docs and tutorial can be found here.
  • The in-repo tutorial can be found here.

Other Resources

  • The code for OptSpace was translated to python from a MATLAB package maintained by Sewoong Oh (UIUC).
  • Transforms and PCoA : Scikit-bio
  • Data For Examples : Qiita

Simulation and Benchmarking

You can’t perform that action at this time.