PlotCorrHeatMap: Pattern hunter, corr heatmap

View source: R/stats_correlations.R

PlotCorrHeatMapR Documentation

Pattern hunter, corr heatmap

Description

Plot correlation heatmap

Usage

PlotCorrHeatMap(
  mSetObj = NA,
  imgName,
  format = "png",
  dpi = 72,
  width = NA,
  target,
  cor.method,
  colors,
  fix.col,
  no.clst,
  fz,
  unit,
  corrCutoff = 0
)

Arguments

mSetObj

Input name of the created mSet Object.

imgName

Input the name of the image to create

format

Select the image format, "png", or "pdf".

dpi

Input the dpi. If the image format is "pdf", users need not define the dpi. For "png" images, the default dpi is 72. It is suggested that for high-resolution images, select a dpi of 300.

width

Input the width, there are 2 default widths, the first, width = NULL, is 10.5. The second default is width = 0, where the width is 7.2. Otherwise users can input their own width.

target

Input "row" to select features, or "col" to select samples.

cor.method

Indicate the correlation method, 'pearson', 'spearman', or 'kendall'.

colors

Indicate the colors for the heatmap, "bwm" for default, "gbr" for red/green, "heat" for heat colors, "topo" for topo colors, and "gray" for gray scale.

fix.col

Logical, fix colors (TRUE) or not (FALSE).

no.clst

Logical, indicate if the correlations should be clustered (TRUE) or not (FALSE).

corrCutoff

set corrCutoff McGill University, Canada License: GNU GPL (>= 2)

viewOpt

Indicate "overview" to get an overview of the heatmap, and "detail" to get a detailed view of the heatmap.

Author(s)

Jeff Xiajeff.xia@mcgill.ca


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