PlotRarefactionCurve: Function to create rarefraction curves of microbiome data

View source: R/mdp_utils.R

PlotRarefactionCurveR Documentation

Function to create rarefraction curves of microbiome data

Description

This functions plots rarefraction curves.

Usage

PlotRarefactionCurve(
  mbSetObj,
  data.src,
  linecolor,
  linetype,
  facet,
  step = 5,
  imgName,
  format = "png",
  dpi = 72,
  interactive = FALSE
)

Arguments

mbSetObj

Input the name of the mbSetObj.

data.src

Character, use "orig" to use the original data or "proc" to use the processed data.

linecolor

Character, input the metadata you wish to group the sample line colors.

linetype

Character, input the metadata you wish to group the sample line types.

facet

Character, input the metadata you wish to group the samples.

step

Numeric, input the step number. Default is set to 5.

imgName

Character, input the name of the plot to be saved.

format

Character, input the type of plot to be saved. Default is set to png.

dpi

Numeric, input the dpi for the plot to be saved. Default is set to 72.

interactive

Boolean, if set to TRUE, saves the plot as an interactive html plot.

Author(s)

Jeff Xia jeff.xia@mcgill.ca McGill University, Canada License: GNU GPL (>= 2)


xia-lab/MicrobiomeAnalystR documentation built on April 17, 2024, 7:45 p.m.