Skip to main content

Robust Aitchison compositional biplots from sparse count data

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

Uploaded Source

Built Distribution

deicode-0.1.3-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: deicode-0.1.3.tar.gz
  • Upload date:
  • Size: 13.9 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.4.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.5.5

File hashes

Hashes for deicode-0.1.3.tar.gz
Algorithm Hash digest
SHA256 ab47ae3f8125e27a5d4df7b536df45333c7402e2981edb507783172cc4bb1c7a
MD5 33b5f15b2a915d6382fd07a73168fd21
BLAKE2b-256 c2725776cb1bb597f35b9cf7c4c2b9cacac4498d9a250abafbd1e6ba2241753b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: deicode-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 15.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.4.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.5.5

File hashes

Hashes for deicode-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a04b6caaec2c8a8c25f97c1a682d6b0ef60d25b301bd4ef1403cbd4f7e1eab7a
MD5 f071ad4909bb9365104173d76e57bf1a
BLAKE2b-256 8f7683e2e32edad39d71aebe36e74686a0933ace82dd18811a0fdaae982437d2

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