write_rprt_with_rcrd: Write report with record

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

Write report with record

Description

write_rprt_with_rcrd() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write report with record. The function is called for its side effects and does not return a value.

Usage

write_rprt_with_rcrd(
  path_to_outp_fl_1L_chr,
  paths_ls,
  rprt_lup,
  abstract_args_ls = NULL,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  header_yaml_args_ls = NULL,
  main_rprt_append_ls = NULL,
  nbr_of_digits_1L_int = 2L,
  options_chr = c("Y", "N"),
  output_type_1L_chr = "PDF",
  rcrd_nm_1L_chr = "AAA_RPRT_WRTNG_MTH",
  rcrd_rprt_append_ls = NULL,
  reference_1L_int = NULL,
  rprt_nm_1L_chr = "AAA_TTU_MDL_CTG",
  rprt_output_type_1L_chr = "PDF",
  start_at_int = c(2, 1),
  use_fake_data_1L_lgl = F
)

Arguments

path_to_outp_fl_1L_chr	Path to output file (a character vector of length one)
paths_ls	Paths (a list)
rprt_lup	Report (a lookup table)
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
header_yaml_args_ls	Header yaml arguments (a list), Default: NULL
main_rprt_append_ls	Main report append (a list), Default: NULL
nbr_of_digits_1L_int	Number of digits (an integer vector of length one), Default: 2
options_chr	Options (a character vector), Default: c("Y", "N")
output_type_1L_chr	Output type (a character vector of length one), Default: 'PDF'
rcrd_nm_1L_chr	Record name (a character vector of length one), Default: 'AAA_RPRT_WRTNG_MTH'
rcrd_rprt_append_ls	Record report append (a list), Default: NULL
reference_1L_int	Reference (an integer vector of length one), Default: NULL
rprt_nm_1L_chr	Report name (a character vector of length one), Default: 'AAA_TTU_MDL_CTG'
rprt_output_type_1L_chr	Report output type (a character vector of length one), Default: 'PDF'
start_at_int	Start at (an integer vector), Default: c(2, 1)
use_fake_data_1L_lgl	Use fake data (a logical vector of length one), Default: F

Value

No return value, called for side effects.

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