Write single predictor multi models outputs
Source:R/fn_write.R
write_sngl_predr_multi_mdls_outps.Rd
write_sngl_predr_multi_mdls_outps() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write single predictor multi models outputs. The function returns Summary of single predictor models (a tibble).
Usage
write_sngl_predr_multi_mdls_outps(
data_tb,
dictionary_tb,
mdl_types_chr,
path_to_write_to_1L_chr,
predr_vals_dbl,
predr_var_desc_1L_chr,
predr_var_nm_1L_chr,
consent_1L_chr = "",
consent_indcs_int = 1L,
covar_var_nms_chr = NA_character_,
depnt_var_min_val_1L_dbl = numeric(0),
depnt_var_nm_1L_chr = "utl_total_w",
fl_nm_pfx_1L_chr = "A_RT_",
folds_1L_int = 10,
mdl_types_lup = NULL,
new_dir_nm_1L_chr = "A_Candidate_Mdls_Cmprsn",
options_chr = c("Y", "N"),
plt_indcs_int = NA_integer_,
start_1L_chr = NULL
)
Arguments
- data_tb
Data (a tibble)
- dictionary_tb
Dictionary (a tibble)
- mdl_types_chr
Model types (a character vector)
- path_to_write_to_1L_chr
Path to write to (a character vector of length one)
- predr_vals_dbl
Predictor values (a double vector)
- predr_var_desc_1L_chr
Predictor variable description (a character vector of length one)
- predr_var_nm_1L_chr
Predictor variable name (a character vector of length one)
- consent_1L_chr
Consent (a character vector of length one), Default: ''
- consent_indcs_int
Consent indices (an integer vector), Default: 1
- covar_var_nms_chr
Covariate variable names (a character vector), Default: 'NA'
- 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'
- fl_nm_pfx_1L_chr
File name prefix (a character vector of length one), Default: 'A_RT_'
- folds_1L_int
Folds (an integer vector of length one), Default: 10
- mdl_types_lup
Model types (a lookup table), Default: NULL
- new_dir_nm_1L_chr
New directory name (a character vector of length one), Default: 'A_Candidate_Mdls_Cmprsn'
- options_chr
Options (a character vector), Default: c("Y", "N")
- plt_indcs_int
Plot indices (an integer vector), Default: NA
- start_1L_chr
Start (a character vector of length one), Default: NULL