write_and_doc_fn_fls: Write and document function files

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

write_and_doc_fn_fls() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write and document function files. The function is called for its side effects and does not return a value. WARNING: This function writes R scripts to your local environment. Make sure to only use if you want this behaviour

Usage

write_and_doc_fn_fls(
  fns_dmt_tb,
  r_dir_1L_chr = "R",
  path_to_pkg_rt_1L_chr = getwd(),
  path_to_user_dmt_dir_1L_chr = "../../../../Documentation/Code/User",
  path_to_dvpr_dmt_dir_1L_chr = "../../../../Documentation/Code/Developer",
  make_pdfs_1L_lgl = T,
  dev_pkgs_chr = NA_character_,
  update_pkgdown_1L_lgl = T
)

Arguments

fns_dmt_tb	Functions documentation (a tibble)
r_dir_1L_chr	R directory (a character vector of length one), Default: 'R'
path_to_pkg_rt_1L_chr	Path to package root (a character vector of length one), Default: getwd()
path_to_user_dmt_dir_1L_chr	Path to user documentation directory (a character vector of length one), Default: '../../../../Documentation/Code/User'
path_to_dvpr_dmt_dir_1L_chr	Path to developer documentation directory (a character vector of length one), Default: '../../../../Documentation/Code/Developer'
make_pdfs_1L_lgl	Make pdfs (a logical vector of length one), Default: T
dev_pkgs_chr	Development packages (a character vector), Default: 'NA'
update_pkgdown_1L_lgl	Update pkgdown (a logical vector of length one), Default: T

readyforwhatsnext/ready4fun documentation built on Nov. 22, 2020, 9:28 p.m.