write_mdl_plt_fl: Write model plot file

In ready4-dev/ready4show: Author Health Economic Analysis Programs and Reporting Templates

Write model plot file

Description

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

Usage

write_mdl_plt_fl(
  plt_fn = NULL,
  path_to_write_to_1L_chr,
  plt_nm_1L_chr,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  fn_args_ls = NULL,
  grpx_fn = grDevices::png,
  height_1L_dbl = 6,
  options_chr = c("Y", "N"),
  rsl_1L_dbl = 300,
  units_1L_chr = "in",
  width_1L_dbl = 6
)

Arguments

plt_fn	Plot (a function), Default: NULL
path_to_write_to_1L_chr	Path to write to (a character vector of length one)
plt_nm_1L_chr	Plot 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
fn_args_ls	Function arguments (a list), Default: NULL
grpx_fn	Graphics (a function), Default: grDevices::png
height_1L_dbl	Height (a double vector of length one), Default: 6
options_chr	Options (a character vector), Default: c("Y", "N")
rsl_1L_dbl	Resolution (a double vector of length one), Default: 300
units_1L_chr	Units (a character vector of length one), Default: 'in'
width_1L_dbl	Width (a double vector of length one), Default: 6

Value

Path to plot (a character vector of length one)

ready4-dev/ready4show documentation built on June 16, 2024, 8:08 a.m.