R/config_modelsummary.R

In modelsummary: Summary Tables and Plots for Statistical Models and Data: Beautiful, Customizable, and Publication-Ready

#' Persistent user settings for the `modelsummary` package
#'
#' @param factory_default Default output format: "tinytable", "kableExtra", "gt", "flextable", "huxtable", "DT", or "markdown" 
#' @param factory_latex Name of package used to generate LaTeX output when `output="latex"`.
#' @param factory_markdown Name of package used to generate LaTeX output when `output="markdown"`.
#' @param factory_html Name of package used to generate LaTeX output when `output="html"`.
#' @param startup_message TRUE or FALSE to show warnings at startup
#' @param reset TRUE to return to default settings.
#' @export
config_modelsummary <- function(
    factory_default,
    factory_latex,
    factory_html,
    factory_markdown,
    startup_message,
    reset = FALSE) {

    # missing() is useful so we can call config_modelsummary() with just one
    # argument without changin all the other ones

    dn <- tools::R_user_dir(package = "modelsummary", which = "config")
    fn <- file.path(dn, "config.rds")

    if (isTRUE(reset) && file.exists(fn)) hush(unlink(fn))

    config <- config_read()

    if (missing(factory_default) && missing(factory_latex) && missing(factory_html) && missing(factory_markdown) && missing(startup_message)) {
        return(config)
    }

    if (!missing(factory_default)) {
        checkmate::assert_choice(
            factory_default, 
            c("tinytable", "kableExtra", "gt", "huxtable", "flextable", "DT", "markdown"),
            null.ok = TRUE)
        if (isTRUE(factory_default == "tinytable")) insight::check_if_installed("tinytable")
        if (isTRUE(factory_default == "kableExtra")) insight::check_if_installed("kableExtra")
        if (isTRUE(factory_default == "gt")) insight::check_if_installed("gt")
        if (isTRUE(factory_default == "huxtable")) insight::check_if_installed("huxtable")
        if (isTRUE(factory_default == "flextable")) insight::check_if_installed("flextable")
        if (isTRUE(factory_default == "DT")) insight::check_if_installed("DT")
        config[["factory_default"]] <- factory_default
    }

    if (!missing(factory_latex)) {
        config[["factory_latex"]] <- factory_latex
    }

    if (!missing(factory_html)) {
        config[["factory_html"]] <- factory_html
    }

    if (!missing(factory_markdown)) {
        config[["factory_markdown"]] <- factory_markdown
    }

    if (!missing(startup_message)) {
        config[["startup_message"]] <- startup_message
        checkmate::assert_flag(startup_message)
    }

    saveRDS(config, file = fn)
}


config_get <- function(x) {
    config <- config_read()
    return(config[[x]])
}


config_delete <- function() {
    dn <- tools::R_user_dir(package = "modelsummary", which = "config")
    fn <- file.path(dn, "config.rds")
    if (file.exists(fn)) hush(unlink(fn))
    insight::format_warning("`modelsummary` returned to default settings.")
}


config_read <- function() {
    dn <- tools::R_user_dir(package = "modelsummary", which = "config")
    if (!dir.exists(dn)) dir.create(dn, recursive = TRUE)
    fn <- file.path(dn, "config.rds")
    if (!file.exists(fn)) {
        config <- list(
            factory_default = "tinytable",
            factory_latex = "tinytable",
            factory_html = "tinytable",
            factory_markdown = "tinytable",
            startup_message = TRUE
        )
    } else {
        config <- readRDS(fn)
    }
    return(invisible(config))
}