plotCorPhm: plotCorPhm

View source: R/heatmaps.R

plotCorPhmR Documentation

plotCorPhm

Description

Plot a correlation matrix as heatmap. Wraps around pheatmap. Note that no clustering will be performed if not supplied with an appropriate clustering dendrogram

Usage

plotCorPhm(
  cc,
  clustDend = NULL,
  sampleAnnot = NA,
  color = colorRampPalette(rev(colpal.cont(n = 11, name = "cb.RdBu")))(100),
  breaks = seq(-1 - 1e-06, 1 + 1e-06, length.out = length(color) + 1),
  border_color = NA,
  ...
)

Arguments

cc

a correlation matrix (as returned by cor())

clustDend

a clustering dendrogram to be used. Set to NULL to disable clustering dendrogram

sampleAnnot

a data.frame containing sample information to color by (corrsponds to annotation_row and annotation_col parameters of pheatmap())

color

see ?pheatmap for details

breaks

see ?pheatmap for details. In this wrapper, the default value corresponds to splitting color across the full range of correlation coefficients [-1,1]

border_color

see ?pheatmap for details

...

parameters passed on to pheatmap()

Value

invisibly the result of a call to pheatmap()

Author(s)

Fabian Mueller


demuellae/muRtools documentation built on Sept. 8, 2023, 4:32 p.m.