write_to_replace_fn_nms: Write to replace function names

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

write_to_replace_fn_nms() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write to replace function names. 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_to_replace_fn_nms(
  rename_tb,
  undocumented_fns_dir_chr = make_undmtd_fns_dir_chr(),
  rt_dev_dir_path_1L_chr = normalizePath("../../../"),
  dev_pkg_nm_1L_chr = get_dev_pkg_nm()
)

Arguments

rename_tb	Rename (a tibble)
undocumented_fns_dir_chr	Undocumented functions directory (a character vector), Default: make_undmtd_fns_dir_chr()
rt_dev_dir_path_1L_chr	Root development directory path (a character vector of length one), Default: normalizePath("../../../")
dev_pkg_nm_1L_chr	Development package name (a character vector of length one), Default: get_dev_pkg_nm()

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