write_box_cox_tfmn: Write box cox transformation

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

Write box cox transformation

Description

write_box_cox_tfmn() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write box cox transformation. The function returns Path to plot (a character vector of length one).

Usage

write_box_cox_tfmn(
  data_tb,
  predr_var_nm_1L_chr,
  path_to_write_to_1L_chr,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  depnt_var_nm_1L_chr = "utl_total_w",
  covar_var_nms_chr = NA_character_,
  fl_nm_pfx_1L_chr = "A_RT",
  height_1L_dbl = 6,
  mdl_types_lup = NULL,
  options_chr = c("Y", "N"),
  start_1L_chr = NULL,
  width_1L_dbl = 6
)

Arguments

data_tb	Data (a tibble)
predr_var_nm_1L_chr	Predictor variable name (a character vector of length one)
path_to_write_to_1L_chr	Path to write to (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
depnt_var_nm_1L_chr	Dependent variable name (a character vector of length one), Default: 'utl_total_w'
covar_var_nms_chr	Covariate variable names (a character vector), Default: 'NA'
fl_nm_pfx_1L_chr	File name prefix (a character vector of length one), Default: 'A_RT'
height_1L_dbl	Height (a double vector of length one), Default: 6
mdl_types_lup	Model types (a lookup table), Default: NULL
options_chr	Options (a character vector), Default: c("Y", "N")
start_1L_chr	Start (a character vector of length one), Default: NULL
width_1L_dbl	Width (a double vector of length one), Default: 6

Value

Path to plot (a character vector of length one)

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