write_and_doc_fn_fls: Write and document function files

In ready4-dev/ready4fun: Author and Document Functions that Implement Transferable Health Economic Model Algorithms

Write and document function files

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.

Usage

write_and_doc_fn_fls(
  pkg_setup_ls,
  make_pdfs_1L_lgl = T,
  update_pkgdown_1L_lgl = T,
  list_generics_1L_lgl = F,
  dev_pkgs_chr = deprecated(),
  fns_dmt_tb = deprecated(),
  path_to_dmt_dir_1L_chr = deprecated(),
  path_to_dvpr_dmt_dir_1L_chr = deprecated(),
  path_to_pkg_rt_1L_chr = deprecated(),
  path_to_user_dmt_dir_1L_chr = deprecated(),
  r_dir_1L_chr = deprecated()
)

Arguments

pkg_setup_ls	Package setup (a list)
make_pdfs_1L_lgl	Make pdfs (a logical vector of length one), Default: T
update_pkgdown_1L_lgl	Update pkgdown (a logical vector of length one), Default: T
list_generics_1L_lgl	List generics (a logical vector of length one), Default: F
dev_pkgs_chr	Development packages (a character vector), Default: deprecated()
fns_dmt_tb	Functions documentation (a tibble), Default: deprecated()
path_to_dmt_dir_1L_chr	Path to documentation directory (a character vector of length one), Default: deprecated()
path_to_dvpr_dmt_dir_1L_chr	Path to developer documentation directory (a character vector of length one), Default: deprecated()
path_to_pkg_rt_1L_chr	Path to package root (a character vector of length one), Default: deprecated()
path_to_user_dmt_dir_1L_chr	Path to user documentation directory (a character vector of length one), Default: deprecated()
r_dir_1L_chr	R directory (a character vector of length one), Default: deprecated()

Value

No return value, called for side effects.

ready4-dev/ready4fun documentation built on April 22, 2024, 8:33 a.m.