getDefaultVolcanoAnnotations: volcano plot Plotly function to get standard volcano...

View source: R/getDefaultVolcanoAnnotations.R

getDefaultVolcanoAnnotationsR Documentation

volcano plot Plotly function to get standard volcano annotations

Description

volcano plot Plotly function to get standard volcano annotations

Usage

getDefaultVolcanoAnnotations(
  maxFoldChange,
  upRegulatedText,
  significanceThreshold,
  adjustedInd = FALSE,
  includeThresholdLabel = TRUE
)

Arguments

maxFoldChange

- numeric - indicates the max value along the x axis for the plot (fold change) - helps anchor the annotations along the x-axis

upRegulatedText

- text to use for "up regulated" groups – down regulated text will simply replace "up" with "down"

significanceThreshold

- numeric - significance threshold

adjustedInd

- logical - indicates if the significance variable has been adjusted with a multiple hypothesis correction

includeThresholdLabel

- logical - whether to include arrow with significance threshold

Value

list of lists of plotly annotation objects – up regulated arror at top of plot (with up regulated text) – down regulated arrow at the top of plot – p value threshold with "p or q < threshold" text and up arrow


cusom/CUSOM.ShinyHelpers documentation built on Oct. 23, 2023, 6:50 a.m.