Skip to content

JelenaBanjac/microbiome-toolbox

Repository files navigation

Freepik

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 also encompasses most of the common machine learning algorithms that exist in different packages.

Features:

  • Data analysis and exploration of microbiota data: analise the bacteria from a given dataset including the longitudinal analysis
  • Data preparation: different ways of preparing data for machine learning model training to build microbiome trajectory
    • Feature extraction: decreasing the number of features used for building the trajectory by selecting the top important ones
    • Reference vs. non-reference data analysis: using different techniques to classify samples into these two groups (optional)
    • Log-ratios data transformation: transforming bacteria abundances to log-ratio w.r.t. the chosen bacteria
  • Microbiome trajectory: build different microbiome trajectories with machine learning models and compare with statistical tests
  • Anomaly detection: detect samples that are labeled as reference but based on the bacteria analysis are actually outliers
  • Boxplot with time: check what are top important bacteria in a reference group of samples w.r.t. time
  • Intervention simulation: what are a few bacteria that should be modified to move the non-reference sample into reference group

Technical glossary

Dataset
Input
  • File name
  • Feature columns
  • Normalization
  • Log ratio bacteria (optional)
  • Reference group choice (optional)
  • Time unit
Processing
  • The dataset is read from the user uploaded csv file or available human and mouse datasets.
  • It consists of several samples collected at different sampling times from multiple subjects. Each sample is represented by several features, particularly bacteria values which specify proportional abundance of different microorganisms, metadata values like diet, country, etc. (optional), sample collection time, sample id, subject id, group is one of the metadata columns renamed to perform group analysis (optional, by default none), and reference group (optional, by default all samples are true, i.e., belong to the reference).
  • Depending on the reference group choice, the definition of reference group samples will be further tuned. Possible choices are user defined (default) which leaves the set of reference and non-reference samples unchanged, and novelty detection with local outlier factor which searches for the reference samples among non-reference samples (unlabeled samples, that were not set to true). The 2 neighbors and Bray-Curtis metric are used as novelty detection parameters. After the novelty detection, the set of reference samples is modified with increased number of reference samples. Note that it only makes sense to use the novelty detection if one specifies set of reference samples and is unsure for the rest.
  • Differentiation score is a useful metric value indicating the level of difference between two groups. We are interested in differentiation score between reference and non-reference. Training a binary classifier on features of the samples and reference groups as a label gives us a model whose performance (F1-score) is indicator of two-groups differentiation. The higher the differentiation score, the better the model is in differentiating the two groups.
  • Feature columns define features that the novelty detection algorithm (if selected) will use as explained abve. Supported options are bacteria columns only, metadata columns only, or both (no time variable). Note that this set of feature columns is not necessarily the same as the feature columns used for building the microbiome trajectory.
  • The time unit is mainly used for visualization purposes.
  • If normalization is selected, it will normalize each feature column, i.e., each column values will range from 0 to 1. It is a useful preprocessing step in cases where features vary in degrees of magnitude and range.
  • Log ratio bacteria is used for calculating the log of the ratio between features and selected bacteria. The log ratio transformation affects the values of bacteria features only and the chosen bacteria, which was used as denominator for log ratio calculations, is removed from feature columns, since after the transformation this column contains only 1 as a value. By default, there is no log ratio bacteria selected (default is none) and proportional abundances of different microorganisms are used as provided by the user.
Output
  • The plot of bacteria abundances or modified bacteria values if log-ratio transformation is performed
  • The heatmap of bacteria abundance or modified bacteria values if log-ratio transformation is performed
  • The plot of ultra-dense longitudinal data with bacteria abundances stacked w.r.t. time Embeddings to 2D/3D space using PCA, UMAP, tSNE
  • Two groups differentiation with confusion matrix after user selects the subset of embedded samples in the low dimensional plot
Reference https://github.com/JelenaBanjac/microbiome-toolbox/blob/main/microbiome/dataset.py
Trajectory
Input
  • Dataset
  • Feature columns
  • Feature extraction
  • Time unit
  • Anomaly type
  • Train indices
Processing
  • The machine learning algorithm called RandomForestRegressor is used to predict sampling times from microbiome composition.
  • Cross-validation resamples data using group k-fold where k is set to 5 folds/splits and the group is subject id.
  • Grid search with cross-validation is used to find the optimal number of estimators for the algorithm which results in the most accurate model predictions. Tested hyperparameter values are 50, 100, and 150.
  • Feature columns define features that the machine learning algorithm will use for training of the model and inference. Supported options are bacteria columns only, metadata columns only, or both (as provided by the user). The number of feature columns can be further decreased if the user selects one of the feature extraction techniques like near zero variance, correlation, and top K important features. The extraction technique internally runs the same machine- learning algorithm for 10 different thresholds. The features of the best-performing model are then used as the final smaller feature columns set.
  • Only samples matching the training indices are used for model training (as provided by the user).
  • The time unit is mainly used for visualization purposes.
  • The last part is detecting anomalies using one of the available detection algorithms, prediction interval, low pass filter, or isolation forest which returns indices of anomalous samples. These anomaly indices are later used for visualization purpose only.
  • Comparison of two trajectories is performed between two fitted lines or curves on the MMI data (not actual MMIs but fits), depending on polynomial degree used. Two linear lines (st degree polynomial) are compared using linear regression statistical analysis and two curves (Nth degree polynomial) are compared using longitudinal statistical analysis method (splinectomeR package).
Output
  • The plot of the reference trajectory: one reference trajectory, scattered reference samples
  • The plot of reference groups: two trajectories for both reference and non-reference, scattered samples
  • The plot of groups: several microbiome trajectories depending on the groups as provided by the user (e.g., countries, diet-type etc.), scattered group samples
  • The plot of anomalies: reference microbiome trajectory, scattered reference samples, highlighted anomalous samples
  • The plot of time boxes: reference microbiome trajectory, scattered reference samples, timeboxes with specified time block ranges (excluding the anomalous samples) and within time-box feature relative-importance
  • The plot of the intervention simulation: reference microbiome trajectory, timeboxes, and intervention with specified time block ranges (excluding the anomalous samples) and within time-box feature relative-importance
  • The plot of longitudinal sample information: reference microbiome trajectory with a confidence interval, longitudinal samples per subject
  • The plot of feature extraction techniques with 10 different thresholds performance summary (if feature extraction is selected in input)
Reference https://github.com/JelenaBanjac/microbiome-toolbox/blob/main/microbiome/trajectory.py

Installation

The microbiome toolbox has a PyPi package available.

Python virtual environment:

# locate yourself to project root
cd $ROOT

# create virtual environment for python
python3.9 -m venv venv

# activate the environment
. venv/bin/activate

# make sure pip is the latest version!
pip install --upgrade pip

# install microbiome-toolbox in edit mode for development
pip install -e .

Note: if you add new libraries to requirements.in, you need to re-generate the requirements.txt in order to reproduce the working state.

# install pip-compile
pip install pip-tools

# generate requirements.txt from requiremenrs.in
pip-compile --allow-unsafe

Run dashboard locally

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

# run the server
python webapp/index.py

# if complains on LegacyVersion, install packaging manually
# pip install packaging==21.3.0

Examples

For the toolbox usage, check the notebooks:

Other

Issues

If you notice any issues, please report them at Github issues. Also, feel free to contribute!

Licence

The project is licensed under the MIT license.

Authors

Jelena Banjac, Shaillay Kumar Dogra, Norbert Sprenger

Citation

Please cite our paper if you use it.

BibTeX citation style:

@article{10.1093/bioinformatics/btac781,
    author = {Banjac, Jelena and Sprenger, Norbert and Dogra, Shaillay Kumar},
    title = "{Microbiome Toolbox: methodological approaches to derive and visualize microbiome trajectories}",
    journal = {Bioinformatics},
    volume = {39},
    number = {1},
    year = {2022},
    month = {12},
    abstract = "{The gut microbiome changes rapidly under the influence of different factors such as age, dietary changes or medications to name just a few. To analyze and understand such changes, we present a Microbiome Toolbox. We implemented several methods for analysis and exploration to provide interactive visualizations for easy comprehension and reporting of longitudinal microbiome data.Based on the abundance of microbiome features such as taxa as well as functional capacity modules, and with the corresponding metadata per sample, the Microbiome Toolbox includes methods for (i) data analysis and exploration, (ii) data preparation including dataset-specific preprocessing and transformation, (iii) best feature selection for log-ratio denominators, (iv) two-group analysis, (v) microbiome trajectory prediction with feature importance over time, (vi) spline and linear regression statistical analysis for testing universality across different groups and differentiation of two trajectories, (vii) longitudinal anomaly detection on the microbiome trajectory and (viii) simulated intervention to return anomaly back to a reference trajectory.The software tools are open source and implemented in Python. For developers interested in additional functionality of the Microbiome Toolbox, it is modular allowing for further extension with custom methods and analysis. The code, python package and the link to the interactive dashboard of Microbiome Toolbox are available on GitHub https://github.com/JelenaBanjac/microbiome-toolboxSupplementary data are available at Bioinformatics online.}",
    issn = {1367-4811},
    doi = {10.1093/bioinformatics/btac781},
    url = {https://doi.org/10.1093/bioinformatics/btac781},
    note = {btac781},
    eprint = {https://academic.oup.com/bioinformatics/article-pdf/39/1/btac781/48520839/btac781.pdf},
}