write_rprt: Write report

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

Write report

Description

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

Usage

write_rprt(
  rprt_type_ls,
  outp_smry_ls,
  append_params_ls = NULL,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  options_chr = c("Y", "N"),
  output_type_1L_chr = "PDF",
  nm_of_mkdn_dir_1L_chr = "Markdown",
  path_to_prjs_dir_1L_chr = "../../../../Data/Project",
  prj_dir_dir_1L_chr = "My_Project",
  push_copy_to_dv_1L_lgl = T,
  reports_dir_1L_chr = "Reports",
  rltv_path_to_data_dir_1L_chr = "../Output",
  section_type_1L_chr = "#"
)

Arguments

rprt_type_ls	Report type (a list)
outp_smry_ls	Output summary (a list)
append_params_ls	Append parameters (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
options_chr	Options (a character vector), Default: c("Y", "N")
output_type_1L_chr	Output type (a character vector of length one), Default: 'PDF'
nm_of_mkdn_dir_1L_chr	Name of markdown directory (a character vector of length one), Default: 'Markdown'
path_to_prjs_dir_1L_chr	Path to projects directory (a character vector of length one), Default: '../../../../Data/Project'
prj_dir_dir_1L_chr	Project directory directory (a character vector of length one), Default: 'My_Project'
push_copy_to_dv_1L_lgl	Push copy to dataverse (a logical vector of length one), Default: T
reports_dir_1L_chr	Reports directory (a character vector of length one), Default: 'Reports'
rltv_path_to_data_dir_1L_chr	Relative path to data directory (a character vector of length one), Default: '../Output'
section_type_1L_chr	Section type (a character vector of length one), Default: '#'

Value

Output summary (a list)

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