write_scripts_to_make_gnrc_and_mthd: Write scripts to make generic and method

In readyforwhatsnext/ready4class: Readyforwhatsnext Tools For Creating And Extending Classes.

Description

write_scripts_to_make_gnrc_and_mthd() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write scripts to make generic and method. 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_scripts_to_make_gnrc_and_mthd(
  fn_name_1L_chr,
  args_chr = c("x"),
  signature_1L_chr = NA_character_,
  pkg_nm_1L_chr = NA_character_,
  where_chr = NA_character_,
  class_nm_1L_chr,
  fn,
  fn_type_chr,
  fn_desc_chr = rep(NA_character_, 2),
  fn_title_1L_chr = NA_character_,
  fn_outp_type_1L_chr = NA_character_,
  imports_chr,
  write_file_ls,
  output_dir_1L_chr,
  append_1L_lgl = T,
  doc_in_class_1L_lgl = F,
  gnrc_exists_1L_lgl,
  overwrite_1L_lgl = F,
  s3_1L_lgl,
  write_1L_lgl
)

Arguments

fn_name_1L_chr	Function name (a character vector of length one)
args_chr	Arguments (a character vector), Default: c("x")
signature_1L_chr	Signature (a character vector of length one), Default: 'NA'
pkg_nm_1L_chr	Package name (a character vector of length one), Default: 'NA'
where_chr	Where (a character vector), Default: 'NA'
class_nm_1L_chr	Class name (a character vector of length one)
fn	Function (a function)
fn_type_chr	Function type (a character vector)
fn_desc_chr	Function description (a character vector), Default: rep(NA_character_, 2)
fn_title_1L_chr	Function title (a character vector of length one), Default: 'NA'
fn_outp_type_1L_chr	Function output type (a character vector of length one), Default: 'NA'
imports_chr	Imports (a character vector)
write_file_ls	Write file (a list)
output_dir_1L_chr	Output directory (a character vector of length one)
append_1L_lgl	Append (a logical vector of length one), Default: T
doc_in_class_1L_lgl	Document in class (a logical vector of length one), Default: F
gnrc_exists_1L_lgl	Generic exists (a logical vector of length one)
overwrite_1L_lgl	Overwrite (a logical vector of length one), Default: F
s3_1L_lgl	S3 (a logical vector of length one)
write_1L_lgl	Write (a logical vector of length one)

readyforwhatsnext/ready4class documentation built on Nov. 14, 2020, 1:29 a.m.