Legend for a heatmap with predefined colors.

This function will invoke the plot function to draw a heatmap legend.

Usage

heatMapLegend(
  cols,
  vals,
  varName,
  tick.text = NULL,
  tick.cex = 1.5,
  barWidth = 3,
  barHeight = 50,
  tickLength = 1,
  xLeft = 88,
  yBot = 25,
  add = FALSE,
  bounds = c(FALSE, FALSE),
  ...
)

Arguments

cols: (character) Vector, containnig the ordered colors that are used for the heatmap.
vals: (numeric) If tick.text is missing, the lowest value in the heatmap
varName: (character) The label of the variable name plotted to the heatmap.
tick.text: (numeric) The values on the heatmap legend. If missing, will be calculated with minVal and maxVal.
tick.cex: (numeric) Letter size of the values on the legend.
barWidth: (numeric) The width (percent) of the bar featuring the colors of the heatmap.
barHeight: (numeric) The height (percent)of the bar featuring the colors of the heatmap.
tickLength: (numeric) The length (percent) of the ticks at the bars.
xLeft: (numeric) The x coordinate of the lower left hand corner of the bar.
yBot: (numeric) The y coordinate of the lower left hand corner of the bar.
add: (logical) Indicates wheter a new plot should be drawn or not. Defaults to FALSE.
bounds: (logical) Vector (length 2) indicating whether open intervals should be indicated for the legend.
...: Arguments passed to the plot function.

Value

The function does not return any value.

Details

The 'percents' refer to the plotting area measured from the lower left corner.