write_mdl_smry_rprt: Write model summary report

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

Write model summary report

Description

write_mdl_smry_rprt() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write model summary report. The function returns Input parameters (a list).

Usage

write_mdl_smry_rprt(
  input_params_ls = NULL,
  abstract_args_ls = NULL,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  dv_ds_nm_and_url_chr = NULL,
  options_chr = c("Y", "N"),
  rprt_lup = NULL,
  rcrd_nm_1L_chr = "AAA_RPRT_WRTNG_MTH",
  rprt_nm_1L_chr = "AAA_TTU_MDL_CTG",
  start_at_int = c(2, 1),
  use_shareable_mdls_1L_lgl = F
)

Arguments

input_params_ls	Input parameters (a list), Default: NULL
abstract_args_ls	Abstract arguments (a list), Default: NULL
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
dv_ds_nm_and_url_chr	Dataverse dataset name and url (a character vector), Default: NULL
options_chr	Options (a character vector), Default: c("Y", "N")
rprt_lup	Report (a lookup table), Default: NULL
rcrd_nm_1L_chr	Record name (a character vector of length one), Default: 'AAA_RPRT_WRTNG_MTH'
rprt_nm_1L_chr	Report name (a character vector of length one), Default: 'AAA_TTU_MDL_CTG'
start_at_int	Start at (an integer vector), Default: c(2, 1)
use_shareable_mdls_1L_lgl	Use shareable models (a logical vector of length one), Default: F

Value

Input parameters (a list)

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