R/system-check-vector-isInstalled.R

In steinbaugh/goalie: Assertive Check Functions

#' Is the package installed?
#'
#' @name check-vector-isInstalled
#' @note Updated 2023-09-29.
#'
#' @inherit check
#' @inheritParams AcidRoxygen::params
#'
#' @param lib `character(1)` or `NULL`.
#' R library location.
#' If left `NULL`, includes all known library paths defined in `.libPaths`.
#'
#' @examples
#' ## TRUE ====
#' isInstalled(c("base", "utils"))
#'
#' ## FALSE ====
#' isInstalled(c("AAA", "BBB"))
NULL



## Vector ======================================================================

#' @describeIn check-vector-isInstalled Vectorized.
#' @export
isInstalled <- function(x, lib = NULL) {
    ok <- hasLength(x)
    if (!isTRUE(ok)) {
        return(ok)
    }
    ok <- isCharacter(x)
    if (!isTRUE(ok)) {
        ko <- rep(x = FALSE, times = length(x))
        return(setCause(ko, false = "not character"))
    }
    pkgs <- .packages(all.available = TRUE, lib.loc = lib)
    # GitHub packages are "owner/repo", so using basename here.
    ok <- basename(x) %in% pkgs
    setCause(ok, false = "not installed")
}



## Scalar ======================================================================

#' @describeIn check-vector-isInstalled Scalar.
#' @export
allAreInstalled <- function(x, lib = NULL) {
    ok <- isInstalled(x, lib = lib)
    if (!all(ok)) {
        return(falseFromVector(ok))
    }
    TRUE
}