Skip to main content

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

Release files for microbiome-toolbox 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for microbiome-toolbox 1.0.2
File Size Uploaded
microbiome-toolbox-1.0.2.tar.gz 31.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for microbiome-toolbox 1.0.2
File Interpreter ABI Platform
microbiome_toolbox-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 65.3 kB

Release files / microbiome-toolbox-1.0.2.tar.gz

Download URL microbiome-toolbox-1.0.2.tar.gz
Size 31.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e9cfad6dd7368b359fc0e99603fada68a6a0c3a8fdf8af0223596394987aaab5
BLAKE2b-256 checksum
How to use checksums
d83100b70e48badc887a6fffa8e1349c20dfc03621204ceb45fc9e5587784cb3
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / microbiome_toolbox-1.0.2-py3-none-any.whl

Download URL microbiome_toolbox-1.0.2-py3-none-any.whl
Size 33.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d86bea50a50919552c09d80bc42b4b539b32c0b5ac8d1c7f998e47f66db6bc5d
BLAKE2b-256 checksum
How to use checksums
2adddfdb7233aaa983769f1b73ed3ba7534ce20e23aecf5e19ab7ae52b88d5f3
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.11

2 release files

0.0.10

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page