heatmap.color.scheme: Break points and color vector for heatmaps.

Description Usage Arguments Value

View source: R/heatmap.R

Description

heatmap.color.scheme computes break points and color vector for heatmaps. Can also plot the HCL space for easier customization of colors.

Usage

1
2
3
heatmap.color.scheme(low.breaks = seq(-3, 0, length.out = 21),
  high.breaks = seq(0, 3, length.out = 21), masked.color = "black",
  col.palette = c("blue.red"), plot = FALSE, gp = gpar())

Arguments

low.breaks

breakpoints for the low color

high.breaks

breakpoints for the low color.

masked.color

color to be used for the gap between the low and high colors.

col.palette

either a palette name or index, or a full specification of an hcl palette. See the 'supported.palettes' definition in the code for examples.

plot

if TRUE, will plot the HCL color space for the chosen color palette.

gp

graphical parameters passed to grid.points and grid.lines when 'plot' is TRUE.

Value

a list with three fields:

breaks

vector with break points, size is one more that 'col'

col

vector with colors, size one less than 'breaks'

masked.idx

idx into 'col' and 'breaks' pointing to the color and the left break point of the masked region (if such a region exists).


vdumeaux/mixtR documentation built on May 3, 2019, 4:58 p.m.