Skip to main content

Microbiome Toolbox

Project description

Microbiome Toolbox

Microbiome toolbox is a collection of tools and methods for microbiome data and it includes data analysis and exploration, data preparation, microbiome trajectory modeling, outlier discovery and intervention. Our toolbox encompasses most of the common machine learning algorithms that exist in different packages.

Features:

  • Data analysis and exploration of microbiota data
  • Data preparation
  • Reference vs. non-reference data analysis
  • Log-ratios data transformation
  • Microbiome trajectory
  • Boxplot with time
  • Intervention simulation.

Installation

The microbiome toolbox has a PyPi package available.

# create environment
conda env create -f environment.yml

# activate environment
conda activate microbiome

# install microbiome toolbox
pip install microbiome-toolbox --user

Run dashboard locally (on your computer)

After you successfully installed the microbiome-toolbox and activated the environment, just execute the following commands:

# set up the development environment (on Linux)
source webapp/environment/.evv.development

# run the server
python webapp/index.py

The only step that differs for Windows is that you should modify the environment variables with values indicated in file webapp/environment/.evv.development. After that, you can run the server on Windows.

Examples

For the toolbox usage, checkout the notebooks:

Issues

If you notice any issues, please report them at Github issues.

Licence

The project is licensed under the MIT license.

Authors

Jelena Banjac, Shaillay Kumar Dogra, Norbert Sprenger

Citation

The code in this repository is released under the terms of the MIT license. Please cite our paper if you use it.

BibTeX citation style:

@article{microbiome_toolbox,
  author = {Banjac, Jelena and Sprenger, Norbert and Dogra, Shaillay Kumar},
  title = {Microbiome Toolbox: Methodological approaches to derive and visualize microbiome trajectories},
  elocation-id = {2022.02.14.479826},
  year = {2022},
  doi = {10.1101/2022.02.14.479826},
  publisher = {Cold Spring Harbor Laboratory},
  URL = {https://www.biorxiv.org/content/early/2022/02/16/2022.02.14.479826},
  eprint = {https://www.biorxiv.org/content/early/2022/02/16/2022.02.14.479826.full.pdf},
  journal = {bioRxiv}
}

APA citation style:

Banjac J, Sprenger N, Dogra SK. 2022. Microbiome Toolbox: Methodological approaches to derive and visualize microbiome trajectories. bioRxiv doi: 10.1101/2022.02.14.479826
https://biorxiv.org/cgi/content/short/2022.02.14.479826v1

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

microbiome-toolbox-1.0.2.tar.gz (31.4 kB view details)

Uploaded Source

Built Distribution

microbiome_toolbox-1.0.2-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file microbiome-toolbox-1.0.2.tar.gz.

File metadata

  • Download URL: microbiome-toolbox-1.0.2.tar.gz
  • Upload date:
  • Size: 31.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.25.1 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.59.0 CPython/3.8.10

File hashes

Hashes for microbiome-toolbox-1.0.2.tar.gz
Algorithm Hash digest
SHA256 e9cfad6dd7368b359fc0e99603fada68a6a0c3a8fdf8af0223596394987aaab5
MD5 5e85d0728c2676e35a42273dcbed34cf
BLAKE2b-256 d83100b70e48badc887a6fffa8e1349c20dfc03621204ceb45fc9e5587784cb3

See more details on using hashes here.

File details

Details for the file microbiome_toolbox-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: microbiome_toolbox-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 33.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.25.1 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.59.0 CPython/3.8.10

File hashes

Hashes for microbiome_toolbox-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d86bea50a50919552c09d80bc42b4b539b32c0b5ac8d1c7f998e47f66db6bc5d
MD5 bb41f7c38a3d0398a9ad76753e260009
BLAKE2b-256 2adddfdb7233aaa983769f1b73ed3ba7534ce20e23aecf5e19ab7ae52b88d5f3

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