regHeatmap: Regular heatmaps with a legend

In alexploner/Heatplus: Heatmaps with row and/or column covariates and colored clusters

Description

Creating regular heatmaps, without annotation, but allowing for a legend

Usage

regHeatmap(x, ...)

## Default S3 method:
regHeatmap(
  x,
  dendrogram = list(clustfun = hclust, distfun = dist, status = "yes"),
  labels = NULL,
  legend = TRUE,
  ...
)

Arguments

x	a numerical matrix
...	extra options passed to annHeatmap2
dendrogram	a list controlling the options for row- and column dendrogram, see annHeatmap2
labels	a list controlling the row- and column labels as well as their location and size, see annHeatmap2
legend	either a logical value, indicating whether to draw a legend at the default location determined by the function, or one of the sides of the plot (1-4), see annHeatmap2

Details

A gelded wrapper for annHeatmap2 that allows for heatmaps without annotation or clustering on the dendrograms, but still offer some control over dendrograms, labels and legend.

These functions generate an object representing the heatmap; in order to produce graphical output, you have to invoke the plot method, see Examples.

Value

An object of class annHeatmap

See Also

annHeatmap, annHeatmap2, plot.annHeatmap

Examples

    
    ## Default
    set.seed(219)
    mat = matrix(rnorm(100), ncol=5)
    map1 = regHeatmap(mat)
    plot(map1)
  

alexploner/Heatplus documentation built on May 23, 2021, 2:01 p.m.