make_smry_of_ts_mdl_outp: Make summary of time series model output

In ready4-dev/specific: Specify Models to Solve Inverse Problems

Make summary of time series model output

Description

make_smry_of_ts_mdl_outp() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make summary of time series model output. The function returns Summary of time series (a list of models).

Usage

make_smry_of_ts_mdl_outp(
  data_tb,
  mdl_nm_1L_chr,
  mdl_types_lup,
  predr_vars_nms_chr,
  predictors_lup,
  backend_1L_chr = getOption("brms.backend", "rstan"),
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  control_ls = NULL,
  depnt_var_min_val_1L_dbl = numeric(0),
  depnt_var_nm_1L_chr = "utl_total_w",
  id_var_nm_1L_chr = "fkClientID",
  iters_1L_int = 4000L,
  options_chr = c("Y", "N"),
  path_to_write_to_1L_chr = NA_character_,
  prior_ls = NULL,
  round_bl_val_1L_chr = "Baseline",
  round_var_nm_1L_chr = "round",
  seed_1L_int = 1000L,
  utl_min_val_1L_dbl = -1
)

Arguments

data_tb	Data (a tibble)
mdl_nm_1L_chr	Model name (a character vector of length one)
mdl_types_lup	Model types (a lookup table)
predr_vars_nms_chr	Predictor variables names (a character vector)
predictors_lup	Predictors (a lookup table)
backend_1L_chr	Backend (a character vector of length one), Default: getOption("brms.backend", "rstan")
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
control_ls	Control (a list), Default: NULL
depnt_var_min_val_1L_dbl	Dependent variable minimum value (a double vector of length one), Default: numeric(0)
depnt_var_nm_1L_chr	Dependent variable name (a character vector of length one), Default: 'utl_total_w'
id_var_nm_1L_chr	Identity variable name (a character vector of length one), Default: 'fkClientID'
iters_1L_int	Iterations (an integer vector of length one), Default: 4000
options_chr	Options (a character vector), Default: c("Y", "N")
path_to_write_to_1L_chr	Path to write to (a character vector of length one), Default: 'NA'
prior_ls	Prior (a list), Default: NULL
round_bl_val_1L_chr	Round baseline value (a character vector of length one), Default: 'Baseline'
round_var_nm_1L_chr	Round variable name (a character vector of length one), Default: 'round'
seed_1L_int	Seed (an integer vector of length one), Default: 1000
utl_min_val_1L_dbl	Utility minimum value (a double vector of length one), Default: -1

Value

Summary of time series (a list of models)

ready4-dev/specific documentation built on Oct. 13, 2023, 7:54 a.m.