chLegend: Calendar Heatmap legend

Description Usage Arguments Value Note

Description

Configure options with respect to the legend in a Calendar Heatmap

Usage

1
2
3
4
5
chLegend(calheatmapR, legend = c(10, 20, 30, 40), display = TRUE,
  cellSize = 10, cellPadding = 2, margin = c(10, 0, 0, 0),
  verticalPosition = c("bottom", "top", "center"),
  horizontalPosition = c("left", "center", "right"),
  orientation = c("horizontal", "vertical"), colours = NULL)

Arguments

calheatmapR

Calendar Heatmap to configure options for

legend

Numeric vector, assigns each range of values to a colour

display

Whether to display the legend

cellSize

Size of the legend cells (in pixels)

cellPadding

Padding between each legend cell (in pixels)

margin

Margins around each legend cell (in pixels)

verticalPosition

Vertical position of the legend

horizontalPosition

Horizontal position of the legend

orientation

Orientation of the legend

colours

Set of colours to compute the heatmap colours, either array or list. List object would contain a 'min' and 'max' elements, with optional elements of 'empty', 'base' and 'overflow'

Value

a calheatmapR with customised label options

Note

see here for options


durtal/calheatmapR documentation built on May 15, 2019, 6:01 p.m.