R/mthd_authorClasses.R

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

#' Author and document classes
#' @description authorClasses.ready4fun_manifest() is an authorClasses method that authors and saves files necessary for creating and documenting classes. 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.
#' @param x An instance of `ready4fun_manifest`, a ready4 submodule class for encapsulating the metadata required for package set-up.
#' @param key_1L_chr Key (a character vector of length one), Default: NULL
#' @param self_serve_1L_lgl Self serve (a logical vector of length one), Default: F
#' @param self_serve_fn_ls Self serve (a list of functions), Default: NULL
#' @return No return value, called for side effects.
#' @rdname authorClasses-methods
#' @export 
#' @importFrom ready4 authorClasses
authorClasses.ready4fun_manifest <- function (x, key_1L_chr = NULL, self_serve_1L_lgl = F, self_serve_fn_ls = NULL) 
{
    x <- write_clss(x, key_1L_chr = key_1L_chr, self_serve_1L_lgl = self_serve_1L_lgl, 
        self_serve_fn_ls = self_serve_fn_ls)
}
#' @rdname authorClasses-methods
#' @aliases authorClasses,ready4fun_manifest-method
#' @importFrom ready4 authorClasses
methods::setMethod("authorClasses", methods::className("ready4fun_manifest", package = "ready4fun"), authorClasses.ready4fun_manifest)