heatmapWithClustering: Draw a customised heatmap with marked clusters in the margins...

View source: R/heatmap-wrappers.R

heatmapWithClusteringR Documentation

Draw a customised heatmap with marked clusters in the margins for a correlation matrix

Description

Draw a customised heatmap with marked clusters in the margins for a correlation matrix

Usage

heatmapWithClustering(data, label.A, label.B, out.A, out.B,
  dend = "none", margins, col = barzinePhdR::colCbc(), ...,
  report = TRUE, index = "####")

Arguments

data

correlation data.frame to plot

label.A

character string. Name of the first data.frame used for the correlation matrix for the additional text.

label.B

character string. Name of the second data.frame used for the correlation matrix for the additional text.

out.A

character string for the plot (x-axis). Name of the first data.frame used for the correlation matrix

out.B

character string for the plot (y-axis). Name of the second data.frame used for the correlation matrix

dend

character string that correspond to (gplots) heatmap.2 "dendrogram" indicating whether to draw 'none', 'row', 'column' or 'both' dendrograms. Defaults to 'both'. However, if Rowv (or Colv) is FALSE or NULL and dendrogram is 'both', then a warning is issued and Rowv (or Colv) arguments are honoured.

margins

numeric vector of length 2 containing the margins (see par(mar= *)) for column and row names, respectively.

col

color palette to use; default barzinePhdR::colC(), i.e. grDevices::colorRampPalette('aliceblue','darkcyan')

...

other parameters that can be handled by (gplots) heatmap.2

report

boolean. Default: TRUE. Output additional text (example for an (r)html report)

index

character string. default:"####" Allows to customise the level of indexing through markdown tags.

Value

a heatmap plot


barzine/barzinePhdR documentation built on Nov. 23, 2024, 8:54 p.m.