apci.plot.hexagram {APCI}R Documentation

plot the hexagram heatmap

Description

plot the cohort effect in the style of hexagram

Usage

apci.plot.hexagram(model, age, period, first_age,
first_period, interval, first_age_isoline = NULL,
first_period_isoline = NULL, isoline_interval = NULL,
color_scale = NULL, color_map = NULL, line_width = 0.5,
line_color = "grey", label_size = 0.5,
label_color = "black", scale_units = "Quintile",
wrap_cohort_labels = TRUE, quantile = NULL)

Arguments

model

A list, inheriting the corresponding results generated by function apci.

age

An object of class character representing the age group index taking on a small number of distinct values in the data. Usually, the vector should be converted to a factor (or the terms of "category" and "enumerated type").

period

An object of class character, similar to the argument of age, representing the time period index in the data.

color_scale

A vector including two numbers indicating the limit of the values to be plotted. The first number is the minimum value to be visualized and the second is the maximum value to be visualized. If NULL, the algorithm will automatically select the limits from the data (estimation results) to set up the scale.

color_map

A vector, representing the color palettes to be used in the figure. The default setting is greys if color_map is NULL. Alternations, for example, can be c("blue", "yellow"), blues, etc.

first_age
first_period
interval
first_age_isoline
first_period_isoline
isoline_interval
line_width
line_color
label_size
label_color
scale_units
wrap_cohort_labels
quantile

[Package APCI version 1.0.6 Index]