set_rho_hist_colors: Prepare the colors to be used in the change point histogram

View source: R/TS_plots.R

set_rho_hist_colorsR Documentation

Prepare the colors to be used in the change point histogram

Description

Based on the inputs, create the set of colors to be used in the change point histogram.

Usage

set_rho_hist_colors(x = NULL, cols = NULL, option = "D", alpha = 1)

Arguments

x

matrix of change point locations (element rhos) from an object of class TS_fit, fit by TS.

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).

option

A character string indicating the color option from viridis to use if "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").

alpha

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

Value

Vector of character hex codes indicating colors to use.

Examples


  data(rodents)
  document_term_table <- rodents$document_term_table
  document_covariate_table <- rodents$document_covariate_table
  LDA_models <- LDA_set(document_term_table, topics = 2)[[1]]
  data <- document_covariate_table
  data$gamma <- LDA_models@gamma
  weights <- document_weights(document_term_table)
  TSmod <- TS(data, gamma ~ 1, nchangepoints = 1, "newmoon", weights)
  set_rho_hist_colors(TSmod$rhos)



LDATS documentation built on Sept. 19, 2023, 5:08 p.m.