Skip to content

OpenOmics/microscope

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Microscope🔬

Microbiome Diversity and Taxonomy Explorer

GitHub issues GitHub license Docker Pulls

This is the home of the shiny application, microscope. Its long-term goals are to empowers researchers to rapidly explore, compare, and visialize microbiome diversity and taxonomy.

Overview

microscope is an R Shiny applications that provides an interactive interface for visualizing diversity metrics and taxonomy abundance from microbiome data. Users can upload metadata, diversity results and taxonomy abundance files, select grouping variables, and generate publication-ready plots.

Microscope’s mission is to accelerate microbiome insights by providing a user-friendly interface for exploring and visualizing microbiome data. It aims to bridge the gap between raw microbiome outputs and interpretable results, enabling researchers to rapidly explore, compare, and visualize microbiome diversity and taxonomy.

Features

Here is a list of features that microscope provides:

  • Upload metadata (.csv) and specify the folder containing diversity files (compatible with metamorph metamorph-generated diversity metrics).
  • Dynamically select grouping variables for visualization.
  • Generate violin plots, boxplots, and scatter plots for alpha diversity metrics.
  • Generate PCoA plots for beta diversity metrics.
  • Optional statistical comparisons between groups.
  • Taxonomy stacked bar plots

Getting Started

Dependencies

Requires: R>=4.0

Before getting started, please ensure you have the following dependencies installed:

  • R: To install any required R packages and run the Shiny app.

Installation

Once you have installed the dependencies above, please run the following commands to setup and install microscope:

# Clone Repository from Github
git clone https://github.com/OpenOmics/microscope.git
# Change your working directory
cd microscope/
# Assume you have R installed, 
# install pak to install the
# any required R packages
Rscript -e "if (!requireNamespace('pak', quietly = TRUE)) install.packages('pak', repos = 'https://cloud.r-project.org')"
# Install the required R packages
# from the DESCRIPTION file
Rscript -e "pak::local_install_dev_deps('.', dependencies = TRUE)"

Running microscope

Once you have installed the required packages, you can run the shiny application using the following command:

# Run the shiny app on your local machine
Rscript -e "shiny::runApp('shiny/', launch.browser = TRUE)"

About

A shiny-based all-in-one microbiome diversity and taxonomy viewer

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •