inlmisc (version 0.4.3)

AddGradientLegend: Add Color Gradient Legend to Plot

Description

This function can be used to add a continuous color gradient legend strip to a plot.

Usage

AddGradientLegend(breaks, pal, at = NULL, n = 5, labels = TRUE,
  scientific = FALSE, title = NULL, strip.dim = c(2, 8), ...)

Arguments

breaks

'numeric'. Set of finite numeric breakpoints for the colors.

pal

'function'. Color palette

at

'numeric'. Vector of points at which tick-marks and labels are to be drawn.

n

'integer'. Desired number of tick-marks to be drawn. Unused if at argument is specified.

labels

'logical' or 'character'. Can either be a logical value specifying whether (numerical) annotations are to be made at the tickmarks, or a character or expression vector of labels to be placed at the tickpoints.

scientific

'logical'. Indicates if labels should be formatted for scientific notation, see ToScientific for details.

title

'character'. Title to be placed at the top of the legend.

strip.dim

'numeric'. Dimensions of the color strip, in picas.

...

Additional arguments to be passed to the GetInsetLocation function---used to position the legend in the main plot region.

Value

Used for the side-effect of a legend drawn on the current graphics device.

See Also

PlotMap

Examples

# NOT RUN {
plot(NA, xlim = c(0, 100), ylim = c(-10, 10),
     xlab = "x", ylab = "y", xaxs = "i", yaxs = "i")
breaks <- 0:200
AddGradientLegend(breaks, GetTolColors, title = "Title", loc = "bottomleft")
AddGradientLegend(breaks, GetTolColors, title = "Title",
                  loc = "bottomleft", inset = c(0.2, 0.1))
breaks <- seq(0, 2e+06, length.out = 5)
AddGradientLegend(breaks, rainbow, loc = "topright", inset = 0.1)
pal <- function(...) rev(rainbow(...))  # reverse colors in palette
AddGradientLegend(breaks, pal, scientific = TRUE, strip.dim = c(1, 14),
                  inset = c(0.2, 0.1))

# }