write_report: Write report

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

Write report

Description

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

Usage

write_report(
  params_ls,
  paths_ls,
  rprt_lup,
  rprt_nm_1L_chr,
  abstract_args_ls = NULL,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  header_yaml_args_ls = NULL,
  nm_of_mkdn_dir_1L_chr = "Markdown",
  options_chr = c("Y", "N"),
  reports_dir_1L_chr = "Reports",
  rltv_path_to_data_dir_1L_chr = "../Output"
)

Arguments

params_ls	Parameters (a list)
paths_ls	Paths (a list)
rprt_lup	Report (a lookup table)
rprt_nm_1L_chr	Report name (a character vector of length one)
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
nm_of_mkdn_dir_1L_chr	Name of markdown directory (a character vector of length one), Default: 'Markdown'
options_chr	Options (a character vector), Default: c("Y", "N")
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'

Value

No return value, called for side effects.

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