plot_legend {heatmaps}R Documentation

Plot a color legend for a heatmap

Description

Plot a color legend for a heatmap

Usage

plot_legend(scale, options)

Arguments

scale

Numeric vector contain min and max for the scale

options

heatmapOptions passed as a list

This function plots a vertical color scale (or legend). With the default parameters, it looks good at about 1/5 the width of a heatmap, about 1cm x 10cm. This function only plots the legend, it does not set margin parameters.

Value

invisible(0)

See Also

plotHeatmapList

Examples

data(HeatmapExamples)
opts = heatmapOptions()
opts$color = "Rainbow"
par(mai=opts$legend.mai)
plot_legend(c(0,1), opts)

[Package heatmaps version 1.6.0 Index]