write_pkg_setup_fls: Write package setup files

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

Write package setup files

Description

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

Usage

write_pkg_setup_fls(
  pkg_desc_ls,
  copyright_holders_chr,
  gh_repo_1L_chr,
  addl_badges_ls = list(),
  badges_lup = NULL,
  check_type_1L_chr = "none",
  consent_1L_chr = "",
  delete_r_dir_cnts_1L_lgl = F,
  lifecycle_stage_1L_chr = "experimental",
  incr_ver_1L_lgl = T,
  on_cran_1L_lgl = F,
  path_to_pkg_logo_1L_chr = NA_character_,
  self_serve_1L_lgl = F,
  add_gh_site_1L_lgl = T,
  dev_pkg_nm_1L_chr = get_dev_pkg_nm(getwd()),
  path_to_pkg_rt_1L_chr = getwd()
)

Arguments

pkg_desc_ls	Package description (a list)
copyright_holders_chr	Copyright holders (a character vector)
gh_repo_1L_chr	Github repository (a character vector of length one)
addl_badges_ls	Additional badges (a list), Default: list()
badges_lup	Badges (a lookup table), Default: NULL
check_type_1L_chr	Check type (a character vector of length one), Default: 'none'
consent_1L_chr	Consent (a character vector of length one), Default: ”
delete_r_dir_cnts_1L_lgl	Delete r directory contents (a logical vector of length one), Default: F
lifecycle_stage_1L_chr	Lifecycle stage (a character vector of length one), Default: 'experimental'
incr_ver_1L_lgl	Increment version (a logical vector of length one), Default: T
on_cran_1L_lgl	On cran (a logical vector of length one), Default: F
path_to_pkg_logo_1L_chr	Path to package logo (a character vector of length one), Default: 'NA'
self_serve_1L_lgl	Self serve (a logical vector of length one), Default: F
add_gh_site_1L_lgl	Add github site (a logical vector of length one), Default: T
dev_pkg_nm_1L_chr	Development package name (a character vector of length one), Default: get_dev_pkg_nm(getwd())
path_to_pkg_rt_1L_chr	Path to package root (a character vector of length one), Default: getwd()

Value

No return value, called for side effects.

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