R/attach.R

In USAID-OHA-SI/gagglr: Corralling Our Gaggle of OHA R Utility Packages

#' Minimially adapted from tidyverse
#' https://github.com/tidyverse/tidyverse/blob/main/R/attach.R


#' Load packages at start up
#' @keywords internal
oha_attach <- function(){

  #1: load core packages
  to_load <- core_unloaded()

  if (length(to_load) == 0)
    return(invisible())

  suppressPackageStartupMessages(
    lapply(to_load, load_pkg)
  )

  #invisible(to_load)

  #2: display messages + warnings
  header <- paste0(
    cli::rule(
      left = crayon::bold("Attaching core OHA packages"),
      right = paste0("gagglr ", utils::packageVersion("gagglr"))
    ))

  ## Get version of each of the core packages
  versions <- vapply(to_load, package_version, character(1))

  ## Check if package is up to date
  update_needed <- vapply(to_load, oha_check, character(1))

  packages <- paste0(
    crayon::green(cli::symbol$tick), " ", crayon::blue(format(to_load)), " ",
    crayon::col_align(versions, max(crayon::col_nchar(versions))), " ",
    crayon::col_align(update_needed, max(crayon::col_nchar(update_needed)))
  )

  if(length(setdiff(core, to_load) > 0)){
    packages_missing <- paste0(
      crayon::red(cli::symbol$cross), " ", crayon::silver(format(setdiff(core, to_load))))

    packages <- c(packages, packages_missing)
  }

  rlang::inform(paste0(header, "\n", paste(packages, collapse = "\n")), class = "packageStartupMessage")

  if(length(setdiff(core, to_load) > 0)) {
    miss_pkgs <- setdiff(core, to_load)

    cli::cli_inform(glue::glue("{length(miss_pkgs)} core package{?s} not found, whose functions may be utilized in this script."),
                    class = "packageStartupMessage")

    cli::cli_inform(glue::glue('To install {miss_pkgs}, start a clean session and run:'),
                    class = "packageStartupMessage")

    miss_pkgs <- paste0("USAID-OHA-SI/", miss_pkgs)
    miss_pkgs <- paste0(deparse(miss_pkgs), collapse = "\n")

    cli::cli_inform(paste0(cli::cat_line('`install.packages(', miss_pkgs, ', repos = c("https://usaid-oha-si.r-universe.dev", "https://cloud.r-project.org"))`')),
                    class = "packageStartupMessage")
  }
}


#' @keywords internal
core_unloaded <- function() {
  core_instlld <- core[vapply(core, requireNamespace, quietly = TRUE, FUN.VALUE = logical(1))]
  core_pkgs <- paste0("package:", core_instlld)
  core_instlld[!core_pkgs %in% search()]
}

#' @keywords internal
load_pkg <- function(pkg){
  do.call(
    "library",
    list(pkg, character.only = TRUE, warn.conflicts = FALSE)
  )
}

#' @keywords internal
package_version <- function(x) {
  version <- as.character(unclass(utils::packageVersion(x))[[1]])

  if (length(version) > 3) {
    version[4:length(version)] <- crayon::red(as.character(version[4:length(version)]))
  }
  paste0(version, collapse = ".")
}