set_TS_summary_plot_cols {LDATS}R Documentation

Create the list of colors for the TS summary plot

Description

A default list generator function that produces the options for the colors controlling the panels of the TS summary plots, so needed because the panels should be in different color schemes. See set_gamma_colors and set_rho_hist_colors for specific details on usage.

Usage

set_TS_summary_plot_cols(
  rho_cols = NULL,
  rho_option = "D",
  rho_alpha = 0.4,
  gamma_cols = NULL,
  gamma_option = "C",
  gamma_alpha = 0.8
)

Arguments

rho_cols

Colors to be used to plot the histograms of change points. Any valid color values (e.g., see colors, rgb) can be input as with a standard plot. The default (rho_cols = NULL) triggers use of viridis color options (see rho_option).

rho_option

A character string indicating the color option from viridis to use if 'rho_cols == NULL'. Four options are available: "magma" (or "A"), "inferno" (or "B"), "plasma" (or "C"), "viridis" (or "D", the default option) and "cividis" (or "E").

rho_alpha

Numeric value [0,1] that indicates the transparency of the colors used. Supported only on some devices, see rgb.

gamma_cols

Colors to be used to plot the LDA topic proportions, time series of observed topic proportions, and time series of fitted topic proportions. Any valid color values (e.g., see colors, rgb) can be input as with a standard plot. The default (gamma_cols = NULL) triggers use of viridis color options (see gamma_option).

gamma_option

A character string indicating the color option from viridis to use if gamma_cols == NULL'. Four options are available: "magma" (or "A"), "inferno" (or "B"), "plasma" (or "C"), "viridis" (or "D", the default option) and "cividis" (or "E").

gamma_alpha

Numeric value [0,1] that indicates the transparency of the colors used. Supported only on some devices, see rgb.

Value

list of elements used to define the colors for the two panels. Contains two elements rho and gamma, each corresponding to the related panel, and each containing default values for entries named cols, option, and alpha.

Examples

  set_TS_summary_plot_cols()


[Package LDATS version 0.3.0 Index]