write_pkg_setup_fls: Write package setup files

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

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. WARNING: This function writes R scripts to your local environment. Make sure to only use if you want this behaviour

Usage

write_pkg_setup_fls(
  path_to_pkg_rt_1L_chr = getwd(),
  dev_pkg_nm_1L_chr = get_dev_pkg_nm(getwd()),
  incr_ver_1L_lgl = T,
  delete_contents_of_R_dir = F,
  copyright_holders_chr,
  use_travis_1L_lgl = T,
  path_to_pkg_logo_1L_chr = NA_character_,
  github_repo_1L_chr,
  lifecycle_stage_1L_chr = "experimental"
)

Arguments

path_to_pkg_rt_1L_chr	Path to package root (a character vector of length one), Default: getwd()
dev_pkg_nm_1L_chr	Development package name (a character vector of length one), Default: get_dev_pkg_nm(getwd())
incr_ver_1L_lgl	Incr ver (a logical vector of length one), Default: T
delete_contents_of_R_dir	PARAM_DESCRIPTION, Default: F
copyright_holders_chr	Copyright holders (a character vector)
use_travis_1L_lgl	Use travis (a logical vector of length one), Default: T
path_to_pkg_logo_1L_chr	Path to package logo (a character vector of length one), Default: 'NA'
github_repo_1L_chr	Github repo (a character vector of length one)
lifecycle_stage_1L_chr	Lifecycle stage (a character vector of length one), Default: 'experimental'

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