write_std_mthd: Write standard method

In ready4-dev/ready4class: Author and Document Classes that Make Health Economic Models Modular

Write standard method

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.

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,
  fn_types_lup,
  pkg_nm_1L_chr,
  output_dir_1L_chr,
  signature_1L_chr = NA_character_,
  append_1L_lgl = T,
  first_1L_lgl = T,
  import_from_chr = NA_character_
)

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)
fn_types_lup	Function types (a lookup table)
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
import_from_chr	Import from (a character vector), Default: 'NA'

Value

No return value, called for side effects.

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