PlotPowerProfile: Plot power profile

View source: R/power_utils.R

PlotPowerProfileR Documentation

Plot power profile

Description

Plot power profile, specifying FDR level and sample size. It will return the image as well as the predicted power at various sample sizes.

Usage

PlotPowerProfile(mSetObj=NA, fdr.lvl, smplSize, imgName, format, dpi, width)

Arguments

mSetObj

Input the name of the created mSetObj (see InitDataObjects)

fdr.lvl

Specify the false-discovery rate level.

smplSize

Specify the maximum sample size, the number must be between 60-1000.

imgName

Specify the name to save the image as.

format

Specify the format of the image to save it as, either "png" or "pdf".

dpi

Specify the dots-per-inch (dpi). By default it is 72, for publications the recommended dpi is 300.

width

Specify the width of the image. NA specifies a width of 9, 0 specifies a width of 7, otherwise input a chosen width.

Author(s)

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


xia-lab/MetaboAnalystR documentation built on Dec. 23, 2024, 3:44 p.m.