doLegend: A simple legend

Description Usage Arguments Details Value See Also Examples

View source: R/annHeatmap.R

Description

Add a simple legend in form of a color bar to a plot.

Usage

1
doLegend(breaks, col, side)

Arguments

breaks

a vector of breaks defining a set of intervals for the data

col

a vector of colors corresponding to the intervals.

side

integer between 1 and 4, indicating on which side of the main plot the legend is supposed to be drawn. Standard interpretation: 1 = below, continuing clock-wise.

Details

This is an extremely simple way of giving a visual impression of what numerical values correspond to a given color. The actual plot is done via a call to image and axis.

Value

The locations of the ticks returned by the call to axis

See Also

plot.annHeatmap, niceBreaks, g2r.colors

Examples

1
2
    ## Set up data
    doLegend(1:9, g2r.colors(8), 2)

Example output



Heatplus documentation built on May 2, 2018, 4:03 a.m.