write_rprt_from_tmpl: Write report from template

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

Write report from template

Description

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

Usage

write_rprt_from_tmpl(
  rprt_type_ls,
  path_to_prjs_dir_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"),
  output_type_1L_chr = "PDF",
  params_ls = NULL,
  prj_dir_1L_chr = "Fake",
  reports_dir_1L_chr = "Reports",
  rltv_path_to_data_dir_1L_chr = "../Output"
)

Arguments

rprt_type_ls	Report type (a list)
path_to_prjs_dir_1L_chr	Path to projects directory (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")
output_type_1L_chr	Output type (a character vector of length one), Default: 'PDF'
params_ls	Parameters (a list), Default: NULL
prj_dir_1L_chr	Project directory (a character vector of length one), Default: 'Fake'
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.