add_utl_predn_to_new_ds: Add utility prediction to new dataset

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

Add utility prediction to new dataset

Description

add_utl_predn_to_new_ds() is an Add function that updates an object by adding data to that object. Specifically, this function implements an algorithm to add utility prediction to new dataset. Function argument data_tb specifies the object to be updated. The function returns Updated (a tibble).

Usage

add_utl_predn_to_new_ds(
  data_tb,
  ingredients_ls,
  mdl_nm_1L_chr,
  analysis_1L_chr = NULL,
  deterministic_1L_lgl = T,
  force_min_max_1L_lgl = T,
  id_var_nm_1L_chr = NULL,
  model_mdl = NULL,
  new_data_is_1L_chr = "Simulated",
  predr_vars_nms_chr = NULL,
  round_var_nm_1L_chr = "Timepoint",
  round_bl_val_1L_chr = "BL",
  utl_cls_fn = NULL,
  utl_var_nm_1L_chr = NULL
)

Arguments

data_tb	Data (a tibble)
ingredients_ls	Ingredients (a list)
mdl_nm_1L_chr	Model name (a character vector of length one)
analysis_1L_chr	Analysis (a character vector of length one), Default: NULL
deterministic_1L_lgl	Deterministic (a logical vector of length one), Default: T
force_min_max_1L_lgl	Force minimum maximum (a logical vector of length one), Default: T
id_var_nm_1L_chr	Identity variable name (a character vector of length one), Default: NULL
model_mdl	Model (a model), Default: NULL
new_data_is_1L_chr	New data is (a character vector of length one), Default: 'Simulated'
predr_vars_nms_chr	Predictor variables names (a character vector), Default: NULL
round_var_nm_1L_chr	Round variable name (a character vector of length one), Default: 'Timepoint'
round_bl_val_1L_chr	Round baseline value (a character vector of length one), Default: 'BL'
utl_cls_fn	Utility class (a function), Default: NULL
utl_var_nm_1L_chr	Utility variable name (a character vector of length one), Default: NULL

Value

Updated (a tibble)

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