Package 'zAMPExplorer'

Title: A Versatile Shiny App for Microbiota Profiling in Clinical Microbiology
Description: A Shiny web application offering a user-friendly, accessible, and reproducible platform for downstream analysis of 16S rRNA-based metagenomics data. Key features include quality control visualizations (e.g., rarefaction curves), community composition plots, and statistical analyses for alpha- and beta-diversity. The app integrates advanced features like community typing with Dirichlet multinomial modeling (DMM) and metadata-driven redundancy analysis (RDA) to explore microbial associations with clinical and experimental variables.
Authors: Sedreh Nassirnia [aut, cre] , Violeta Castelo-Szekely [aut], Farid Chaabane [aut], Valentin Scherz [aut], Trestan Pillonel [aut], Gilbert Greub [aut], Claire Bertelli [aut]
Maintainer: Sedreh Nassirnia <[email protected]>
License: GPL-3
Version: 0.1.0
Built: 2024-12-20 06:33:56 UTC
Source: https://github.com/metagenlab/zAMPExplorer

Help Index


Launch the zAMPExplorer Application

Description

zAMPExplorer provides an interactive interface for analyzing and visualizing microbiome sequencing data, particularly the output of the zAMP pipeline (phyloseq objects). It includes functionalities such as: compositional barplots, heatmaps, diversity metrics, beta-diversity analyses, and more.

Usage

zAMPExplorer_app(
  onStart = NULL,
  options = list(),
  enableBookmarking = NULL,
  uiPattern = "/",
  ...
)

Arguments

onStart

A function that will be called before the app is actually run. This is only needed for shinyAppObj, since in the shinyAppDir case, a global.R file can be used for this purpose.

options

Named options that should be passed to the runApp call (these can be any of the following: "port", "launch.browser", "host", "quiet", "display.mode" and "test.mode"). You can also specify width and height parameters which provide a hint to the embedding environment about the ideal height/width for the app.

enableBookmarking

Can be one of "url", "server", or "disable". The default value, NULL, will respect the setting from any previous calls to enableBookmarking(). See enableBookmarking() for more information on bookmarking your app.

uiPattern

A regular expression that will be applied to each GET request to determine whether the ui should be used to handle the request. Note that the entire request path must match the regular expression in order for the match to be considered successful.

...

Arguments to pass to golem options. See get_golem_options for more details.

Value

A shiny.appobj object representing the running Shiny application.

Features

  • Read QC, Taxa overviews.

  • Compositional barplots, relative abundance heatmaps.

  • Alpha and beta diversity visualizations.

  • Differential abundance testing using MaAsLin2.

  • Community typing using Dirichlet Multinomial Mixtures.

  • Interactive RDA ordination plots.

See Also

Useful links:

Examples

if (interactive()) {
  zAMPExplorer_app()
}