Allows customisation of the domain elements in a calendar heatmap.
calheatmapR(data = pletcher) %>%
chDomain(domain = "hour", subDomain = "min", range = 10)| argument | details | cal-heatmap equivalent |
|---|---|---|
| calheatmapR | a calendar heatmap returned by calheatmapR |
|
| domain | type of domain | domain |
| subDomain | type of subDomain | subDomain |
| start | Date, in format YYYY-MM-DD | start |
| range | number of domains to display | range |
| cellSize | size of each domain (in pixels) | cellSize |
| cellPadding | space between each subDomain (pixels) | cellPadding |
| cellRadius | border radius of subDomain cells, for round corners (pixels) | cellRadius |
| gutter | space between each domain | domainGutter |
| margin | margins around each domain | domainMargin |
| colLimit | number of columns to split domains into | colLimit |
| rowLimit | number of rows to split domains into | rowLimit |
| dynamicDimension | dynamic width and height of domains | domainDynamicDimension |
| verticalOrientation | display calendar heatmap vertically | verticalOrientation |
For this example we’ll use the example data set included in the package which tracks the performance of racehorse trainer Todd Pletcher, it charts the percentage of horses his horses beat in races at Gulfstream Park. (see data for details about the required data format).
data(pletcher)
calheatmapR(data = pletcher, height = "100%") %>%
chDomain(domain = "month",
subDomain = "day",
start = "2012-11-01")Looking at implementing a few other options
calheatmapR(data = pletcher, height = "100%") %>%
chDomain(domain = "month",
subDomain = "day",
start = "2012-11-01",
range = 5,
cellSize = 18,
cellRadius = 20,
verticalOrientation = TRUE)