transform_tb_to_mdl_inp: Transform tibble to model input

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

Transform tibble to model input

Description

transform_tb_to_mdl_inp() is a Transform function that edits an object in such a way that core object attributes - e.g. shape, dimensions, elements, type - are altered. Specifically, this function implements an algorithm to transform tibble to model input. Function argument data_tb specifies the object to be updated. Argument depnt_var_min_val_1L_dbl provides the object to be updated. The function returns Transformed for model input (a tibble).

Usage

transform_tb_to_mdl_inp(
  data_tb,
  depnt_var_min_val_1L_dbl = numeric(0),
  depnt_var_max_val_1L_dbl = 0.99999,
  depnt_var_nm_1L_chr = "utl_total_w",
  predr_vars_nms_chr,
  id_var_nm_1L_chr = "fkClientID",
  round_var_nm_1L_chr = "round",
  round_bl_val_1L_chr = "Baseline",
  drop_all_msng_1L_lgl = T,
  scaling_fctr_dbl = 1,
  tfmn_1L_chr = "NTF",
  tidy_1L_lgl = F,
  ungroup_1L_lgl = F
)

Arguments

data_tb	Data (a tibble)
depnt_var_min_val_1L_dbl	Dependent variable minimum value (a double vector of length one), Default: numeric(0)
depnt_var_max_val_1L_dbl	Dependent variable maximum value (a double vector of length one), Default: 0.99999
depnt_var_nm_1L_chr	Dependent variable name (a character vector of length one), Default: 'utl_total_w'
predr_vars_nms_chr	Predictor variables names (a character vector)
id_var_nm_1L_chr	Identity variable name (a character vector of length one), Default: 'fkClientID'
round_var_nm_1L_chr	Round variable name (a character vector of length one), Default: 'round'
round_bl_val_1L_chr	Round baseline value (a character vector of length one), Default: 'Baseline'
drop_all_msng_1L_lgl	Drop all missing (a logical vector of length one), Default: T
scaling_fctr_dbl	Scaling factor (a double vector), Default: 1
tfmn_1L_chr	Transformation (a character vector of length one), Default: 'NTF'
tidy_1L_lgl	Tidy (a logical vector of length one), Default: F
ungroup_1L_lgl	Ungroup (a logical vector of length one), Default: F

Value

Transformed for model input (a tibble)

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