Skip to main content

Robust Aitchison RPCA toolbox

Project description


[![Build Status](https://travis-ci.org/cameronmartino/DEICODE.svg?branch=master)](https://travis-ci.org/cameronmartino/DEICODE)
[![Coverage Status](https://coveralls.io/repos/github/cameronmartino/DEICODE/badge.svg)](https://coveralls.io/github/cameronmartino/DEICODE)

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

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.

## Installation

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

# stable version (currently v.0.1.0)
pip install deicode

# dev. version
pip install git+https://github.com/cameronmartino/DEICODE.git

## Tutorials

* [What is Robust Aitchison RPCA](https://github.com/cameronmartino/DEICODE/blob/master/ipynb/introduction.ipynb)

### Qiime2 tutorial

* [Sleep Apnea Biplots](https://github.com/cameronmartino/DEICODE/blob/master/ipynb/sleep_apnea/SleepApnea-qiime2-tutorial.ipynb)

First make sure that qiime2 is installed before installing deicode. Then run

```
qiime dev refresh-cache
```

Once qiime2 is properly interfaced with deicode, you can import your biom tables
into Artifacts. Here we will be using the [Sleep Apnea dataset](https://qiita.ucsd.edu/study/description/10422)
as an example.

```
qiime tools import \
--input-path qiita_10422_table.biom \
--output-path qiita_10422_table.biom.qza \
--type FeatureTable[Frequency]
```
You can then run the qiime2 deicode rpca-biplot commmand as follows.

```
qiime deicode rpca-biplot \
--i-table qiita_10422_table.biom.qza \
--p-min-feature-count 10 \
--p-min-sample-count 500 \
--o-biplot ordination.qza
```
Once you have this, you can directly visualize this in emperor
```
qiime emperor biplot \
--i-biplot ordination.qza \
--m-sample-metadata-file qiita_10422_metadata.tsv \
--m-feature-metadata-file taxonomy.qza \
--o-visualization biplot.qzv \
--p-number-of-features 8
```
You can view the resulting visualization at https://view.qiime2.org.
It should look as follows
![biplot](https://github.com/cameronmartino/DEICODE/blob/master/ipynb/sleep_apnea/qiime_view.png)

### Python Tutorial

* [Sleep Apnea Log Ratio Tutorial](https://github.com/cameronmartino/DEICODE/blob/master/ipynb/sleep_apnea/SleepApnea-python-tutorial.ipynb)

## Simulation Benchmarking

* [simulations](https://github.com/cameronmartino/DEICODE/tree/master/benchmarking/simulations)
* [case studies](https://github.com/cameronmartino/DEICODE/tree/master/benchmarking/case_studies)

## Other Resources

The code for OptSpace was translated to python from a [MATLAB package](http://swoh.web.engr.illinois.edu/software/optspace/code.html) maintained by Sewoong Oh (UIUC).

[Simulation and Case Study Benchmarking](https://github.com/cameronmartino/DEICODE/tree/master/benchmarking)

- Transforms and PCoA : [Scikit-bio](https://github.com/biocore/scikit-bio)
- Data For Examples : [Qiita](https://qiita.ucsd.edu/)


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

deicode-0.1.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

deicode-0.1.1-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file deicode-0.1.1.tar.gz.

File metadata

  • Download URL: deicode-0.1.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.5

File hashes

Hashes for deicode-0.1.1.tar.gz
Algorithm Hash digest
SHA256 689e546a8b62b6f3f8fb519f1cdac10600d14da157240bf9756d6a1b94e55e56
MD5 ac6b14be4c731092a1974908bfd87a39
BLAKE2b-256 ebf3f9344dc37efd270067c99181a25fad50ef8a426b9115003beec42b831036

See more details on using hashes here.

File details

Details for the file deicode-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: deicode-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.5

File hashes

Hashes for deicode-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 876dc7c2f703484df096653f035a52559e30df57693e4206e12218d2522f300c
MD5 fc62ed487637f54c01244b61cfe5d97d
BLAKE2b-256 706a631fb672c7447566bcfcc1ae904f177b3a366b565909bb14fcecc080f310

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