write_mkdn_from_pkg: Write markdown from package

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

Write markdown from package

Description

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

Usage

write_mkdn_from_pkg(
  pkg_nm_1L_chr,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  dest_dir_1L_chr = "Markdown",
  options_chr = c("Y", "N"),
  overwrite_1L_lgl = F
)

Arguments

pkg_nm_1L_chr	Package name (a character vector of length one)
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
dest_dir_1L_chr	Destination 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: F

Value

No return value, called for side effects.

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