write_rndrd_rprt: Write rendered report

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

Write rendered report

Description

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

Usage

write_rndrd_rprt(
  rprt_type_ls,
  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"),
  overwrite_1L_lgl = T,
  params_ls = list(output_type_1L_chr = "HTML"),
  path_to_rprt_dir_1L_chr = "./",
  path_to_write_dirs_to_1L_chr = NA_character_
)

Arguments

rprt_type_ls	Report type (a list)
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")
overwrite_1L_lgl	Overwrite (a logical vector of length one), Default: T
params_ls	Parameters (a list), Default: list(output_type_1L_chr = "HTML")
path_to_rprt_dir_1L_chr	Path to report directory (a character vector of length one), Default: './'
path_to_write_dirs_to_1L_chr	Path to write directories to (a character vector of length one), Default: 'NA'

Value

No return value, called for side effects.

See Also

rmarkdown::render()

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