write_std_mthd: Write standard method

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

Description

write_std_mthd() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write standard 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_std_mthd(
  fn,
  fn_name_1L_chr,
  class_nm_1L_chr,
  fn_desc_chr,
  fn_title_1L_chr,
  fn_outp_type_1L_chr,
  pkg_nm_1L_chr,
  output_dir_1L_chr,
  signature_1L_chr = NA_character_,
  append_1L_lgl = T,
  first_1L_lgl = T
)

Arguments

fn	Function (a function)
fn_name_1L_chr	Function name (a character vector of length one)
class_nm_1L_chr	Class name (a character vector of length one)
fn_desc_chr	Function description (a character vector)
fn_title_1L_chr	Function title (a character vector of length one)
fn_outp_type_1L_chr	Function output type (a character vector of length one)
pkg_nm_1L_chr	Package name (a character vector of length one)
output_dir_1L_chr	Output directory (a character vector of length one)
signature_1L_chr	Signature (a character vector of length one), Default: 'NA'
append_1L_lgl	Append (a logical vector of length one), Default: T
first_1L_lgl	First (a logical vector of length one), Default: T

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