R/update.R

In healthyverse: Easily Install and Load the 'healthyverse'

#' Update healthyverse packages
#'
#' This will check to see if all healthyverse packages (and optionally, their
#' dependencies) are up-to-date, and will install after an interactive
#' confirmation.
#' @return This function do not return a value but rather are used for side effects.
#' @inheritParams healthyverse_deps
#' @export
#' @examples
#' \dontrun{
#' healthyverse_update()
#' }
healthyverse_update <- function(recursive = FALSE, repos = getOption("repos")) {

    deps <- healthyverse_deps(recursive, repos)
    behind <- dplyr::filter(deps, behind)

    if (nrow(behind) == 0) {
        cli::cat_line("All healthyverse packages up-to-date")
        return(invisible())
    }

    cli::cat_line("The following packages are out of date:")
    cli::cat_line()
    cli::cat_bullet(format(behind$package), " (", behind$local, " -> ", behind$cran, ")")

    cli::cat_line()
    cli::cat_line("Start a clean R session then run:")

    pkg_str <- paste0(deparse(behind$package), collapse = "\n")
    cli::cat_line("install.packages(", pkg_str, ")")

    invisible()
}

#' Get a situation report on the healthyverse
#'
#' This function gives a quick overview of the versions of R and RStudio as
#' well as all healthyverse packages. It's primarily designed to help you get
#' a quick idea of what's going on when you're helping someone else debug
#' a problem.
#'
#' @return Get a situation report of the healthyverse
#' @export
healthyverse_sitrep <- function() {
    cli::cat_rule("R & RStudio")
    if (rstudioapi::isAvailable()) {
        cli::cat_bullet("RStudio: ", rstudioapi::getVersion())
    }
    cli::cat_bullet("R: ", getRversion())

    deps <- healthyverse_deps()
    package_pad <- format(deps$package)
    packages <- ifelse(
        deps$behind,
        paste0(cli::col_yellow(cli::style_bold(package_pad)), " (", deps$local, " < ", deps$cran, ")"),
        paste0(package_pad, " (", deps$cran, ")")
    )

    cli::cat_rule("Core packages")
    cli::cat_bullet(packages[deps$package %in% core])
    cli::cat_rule("Non-core packages")
    cli::cat_bullet(packages[!deps$package %in% core])
}

#' List all healthyverse dependencies
#'
#' @param recursive If \code{TRUE}, will also list all dependencies of
#'   healthyverse packages.
#' @param repos The repositories to use to check for updates.
#'   Defaults to \code{getOptions("repos")}.
#'
#' @return
#' A message indicating the dependencies of the healthyverse
#'
#' @export
healthyverse_deps <- function(recursive = FALSE, repos = getOption("repos")) {
    pkgs <- utils::available.packages(repos = repos)
    deps <- tools::package_dependencies("healthyverse", pkgs, recursive = recursive)

    pkg_deps <- unique(sort(unlist(deps)))

    base_pkgs <- c(
        "base", "compiler", "datasets", "graphics", "grDevices", "grid",
        "methods", "parallel", "splines", "stats", "stats4", "tools", "tcltk",
        "utils"
    )
    pkg_deps <- setdiff(pkg_deps, base_pkgs)

    tool_pkgs <- c("cli", "crayon", "rstudioapi")
    pkg_deps <- setdiff(pkg_deps, tool_pkgs)

    cran_version <- lapply(pkgs[pkg_deps, "Version"], base::package_version)
    local_version <- lapply(pkg_deps, packageVersion)

    behind <- purrr::map2_lgl(cran_version, local_version, `>`)

    tibble::tibble(
        package = pkg_deps,
        cran = cran_version %>% purrr::map_chr(as.character),
        local = local_version %>% purrr::map_chr(as.character),
        behind = behind
    )
}

packageVersion <- function(pkg) {
    if (rlang::is_installed(pkg)) {
        utils::packageVersion(pkg)
    } else {
        0
    }
}