author-methods: Author and save files

In ready4-dev/ready4fun: Author and Document Functions that Implement Transferable Health Economic Model Algorithms

Author and save files

Description

author.ready4fun_manifest() is an author method that authors and saves files to local or remote locations. This method is implemented for the ready4 submodule class for encapsulating the metadata required for package set-up. The function is called for its side effects and does not return a value.

author.ready4fun_metadata_a() is an author method that authors and saves files to local or remote locations. This method is implemented for the ready4 submodule class for package metadata required for initial package set-up step. The function is called for its side effects and does not return a value.

Usage

author.ready4fun_manifest(
  x,
  append_1L_lgl = F,
  build_vignettes_1L_lgl = TRUE,
  clean_license_1L_lgl = TRUE,
  consent_1L_chr = "",
  examples_chr = character(0),
  key_1L_chr = Sys.getenv("DATAVERSE_KEY"),
  list_generics_1L_lgl = T,
  project_1L_chr = "Model",
  self_serve_1L_lgl = F,
  self_serve_fn_ls = NULL,
  suggest_chr = "pkgload"
)

## S4 method for signature 'ready4fun_manifest'
author(
  x,
  append_1L_lgl = F,
  build_vignettes_1L_lgl = TRUE,
  clean_license_1L_lgl = TRUE,
  consent_1L_chr = "",
  examples_chr = character(0),
  key_1L_chr = Sys.getenv("DATAVERSE_KEY"),
  list_generics_1L_lgl = T,
  project_1L_chr = "Model",
  self_serve_1L_lgl = F,
  self_serve_fn_ls = NULL,
  suggest_chr = "pkgload"
)

author.ready4fun_metadata_a(x, consent_1L_chr = "", self_serve_1L_lgl = F)

## S4 method for signature 'ready4fun_metadata_a'
author(x, consent_1L_chr = "", self_serve_1L_lgl = F)

Arguments

x	An instance of ready4fun_metadata_a, a ready4 submodule class for package metadata required for initial package set-up step.
append_1L_lgl	Append (a logical vector of length one), Default: F
build_vignettes_1L_lgl	Build vignettes (a logical vector of length one), Default: TRUE
clean_license_1L_lgl	Clean license (a logical vector of length one), Default: TRUE
consent_1L_chr	Consent (a character vector of length one), Default: ”
examples_chr	Examples (a character vector), Default: character(0)
key_1L_chr	Key (a character vector of length one), Default: Sys.getenv("DATAVERSE_KEY")
list_generics_1L_lgl	List generics (a logical vector of length one), Default: T
project_1L_chr	Project (a character vector of length one), Default: 'Model'
self_serve_1L_lgl	Self serve (a logical vector of length one), Default: F
self_serve_fn_ls	Self serve (a list of functions), Default: NULL
suggest_chr	Suggest (a character vector), Default: 'pkgload'

Value

x (An object)

No return value, called for side effects.

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