write_script_to_make_mthd: Write script to make method

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

Description

write_script_to_make_mthd() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write script to make 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_script_to_make_mthd(
  write_file_ls,
  gen_mthd_pair_ls,
  class_nm_1L_chr,
  fn_name_1L_chr,
  fn_type_1L_chr,
  fn_desc_1L_chr = NA_character_,
  fn_outp_type_1L_chr = NA_character_,
  imports_chr,
  write_1L_lgl = T,
  append_1L_lgl = T,
  doc_in_class_1L_lgl = F
)

Arguments

write_file_ls	Write file (a list)
gen_mthd_pair_ls	Generate method pair (a list)
class_nm_1L_chr	Class name (a character vector of length one)
fn_name_1L_chr	Function name (a character vector of length one)
fn_type_1L_chr	Function type (a character vector of length one)
fn_desc_1L_chr	Function description (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_1L_lgl	Write (a logical vector of length one), Default: T
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

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