colGradLegend: Adds a colour gradient legend to a base plot

In helophilus/ColsTools: A variety of convenience tools and short-cuts

Description

(x,y,colramp,colno,align=c("v","h"),lengthmult=1,width=2,labs=0:1,...)

Usage

colGradLegend(x, y, colramp, colno, align = c("v", "h"), frac = 25,
  width = 5, labs = 0:1, tsize = 0.8, scaleoffset = 0, Round = 1, ...)

Arguments

x	the x coordinate for the lowermost (if vertical) or leftmost (if horizontal) end of the gradient bar.
y	the y coordinate pairing to x.
colramp	a colour ramp using, e.g., colorRampPalette().
colno	the number of colours of the colour ramp in the gradient.
align	whether the gradient bar should be aligned vertically ('v') or horizontally ('h').
frac	a multiplier for the length of the bar, given as a percentage of the axis span. Default is 25.
width	thickness of bar as a percentage of total axis range.
labs	scale values to be printed alongside the bar. Must be at least 2.
tsize	magnification factor for size of text labels
scaleoffset	amount of offset between gradient bar and scale value. Value is percentage of total scale, default is 0.
Round	is the number of digits the scale values are rounded to.
...	other plotting arguments. Really designed for use of xpd = TRUE to position the bar outside of the plotting area. Other plotting arguments have not been tested and may produce errors.

Details

places a gradient bar on a plot along with labels and a title. There is some flexibility though it has not been extensively tested.

helophilus/ColsTools documentation built on May 30, 2019, 4:03 p.m.