R/mthd_author.R

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.
#' @param x An instance of `ready4fun_manifest`, a ready4 submodule class for encapsulating the metadata required for package set-up.
#' @param append_1L_lgl Append (a logical vector of length one), Default: F
#' @param build_vignettes_1L_lgl Build vignettes (a logical vector of length one), Default: TRUE
#' @param clean_license_1L_lgl Clean license (a logical vector of length one), Default: TRUE
#' @param consent_1L_chr Consent (a character vector of length one), Default: ''
#' @param examples_chr Examples (a character vector), Default: character(0)
#' @param key_1L_chr Key (a character vector of length one), Default: Sys.getenv("DATAVERSE_KEY")
#' @param list_generics_1L_lgl List generics (a logical vector of length one), Default: T
#' @param project_1L_chr Project (a character vector of length one), Default: 'Model'
#' @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
#' @param suggest_chr Suggest (a character vector), Default: 'pkgload'
#' @return x (An object)
#' @rdname author-methods
#' @export 
#' @importFrom ready4 ratify author authorData authorClasses renew authorFunctions authorReport write_extra_pkgs_to_actions write_to_edit_workflow
#' @importFrom stringr str_replace_all
author.ready4fun_manifest <- function (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") 
{
    x <- ready4::ratify(x, append_1L_lgl = append_1L_lgl)
    if (!is.null(x$problems_ls)) {
        message("Execution halted - fix issues with manifest before making a new call to author.")
    }
    else {
        message("Manifest has been validated. Proceeding to package set-up.")
        ready4::author(x$initial_ls)
        write_citation_fl(x)
        x <- ready4::authorData(x)
        x <- ready4::authorClasses(x, key_1L_chr = key_1L_chr, 
            self_serve_1L_lgl = self_serve_1L_lgl, self_serve_fn_ls = self_serve_fn_ls)
        x <- ready4::renew(x, append_1L_lgl = append_1L_lgl, 
            type_1L_chr = "fns_dmt", key_1L_chr = key_1L_chr)
        ready4::authorFunctions(x, list_generics_1L_lgl = list_generics_1L_lgl)
        ready4::authorReport(x, key_1L_chr = key_1L_chr)
        write_fns_dmt_tb(x)
        ready4::write_extra_pkgs_to_actions(path_to_dir_1L_chr = ".github/workflows", 
            consent_1L_chr = consent_1L_chr)
        ready4::write_to_edit_workflow("pkgdown.yaml", consent_1L_chr = consent_1L_chr)
        if (!consent_1L_chr %in% c("Y", "N")) {
            consent_1_1L_chr <- make_prompt(prompt_1L_chr = paste0("Do you confirm ('Y') that you want to edit the file ", 
                ".github/workflows/R-CMD-check.yaml ?"), options_chr = c("Y", 
                "N"), force_from_opts_1L_chr = T)
        }
        else {
            consent_1_1L_chr <- consent_1L_chr
        }
        if (consent_1_1L_chr %in% c("Y")) {
            readLines(".github/workflows/R-CMD-check.yaml") %>% 
                stringr::str_replace_all("r-lib/actions/setup-r@master", 
                  "r-lib/actions/setup-r@v2") %>% stringr::str_replace_all("r-lib/actions/setup-pandoc@master", 
                "r-lib/actions/setup-pandoc@v2") %>% writeLines(con = ".github/workflows/R-CMD-check.yaml")
        }
        else {
            warning("Write request cancelled - no new files have been written.")
        }
        if (!file.exists("pkgdown/extra.css")) {
            if (!consent_1L_chr %in% c("Y", "N")) {
                consent_2_1L_chr <- make_prompt(prompt_1L_chr = paste0("Do you confirm ('Y') that you want to edit the file ", 
                  "pkgdown/extra.css ?"), options_chr = c("Y", 
                  "N"), force_from_opts_1L_chr = T)
            }
            else {
                consent_2_1L_chr <- consent_1L_chr
            }
            if (consent_2_1L_chr %in% c("Y")) {
                writeLines(c("main table {", "  display: table;", 
                  "}"), con = "pkgdown/extra.css")
            }
            else {
                warning("Write request cancelled - no new files have been written.")
            }
        }
        write_to_tidy_pkg(x, build_vignettes_1L_lgl = TRUE, clean_license_1L_lgl = TRUE, 
            consent_1L_chr = consent_1L_chr, examples_chr = character(0), 
            project_1L_chr = "Model", suggest_chr = "pkgload")
    }
    return(x)
}
#' @rdname author-methods
#' @aliases author,ready4fun_manifest-method
#' @importFrom ready4 author
methods::setMethod("author", methods::className("ready4fun_manifest", package = "ready4fun"), author.ready4fun_manifest)
#' Author and save files
#' @description 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.
#' @param x An instance of `ready4fun_metadata_a`, a ready4 submodule class for package metadata required for initial package set-up step.
#' @param consent_1L_chr Consent (a character vector of length one), Default: ''
#' @param self_serve_1L_lgl Self serve (a logical vector of length one), Default: F
#' @return No return value, called for side effects.
#' @rdname author-methods
#' @export 
#' @importFrom rlang exec
#' @importFrom ready4 author
author.ready4fun_metadata_a <- function (x, consent_1L_chr = "", self_serve_1L_lgl = F) 
{
    rlang::exec(write_pkg_setup_fls, !!!x, consent_1L_chr = consent_1L_chr, 
        self_serve_1L_lgl = self_serve_1L_lgl)
}
#' @rdname author-methods
#' @aliases author,ready4fun_metadata_a-method
#' @importFrom ready4 author
methods::setMethod("author", methods::className("ready4fun_metadata_a", package = "ready4fun"), author.ready4fun_metadata_a)