R/brew_install.R

In briandconnelly/homebrew: Install and Manage Packages using 'Homebrew'

#' Install a formula or cask
#'
#' @description `brew_install()` installs a formula or cask.
#' For information about additional arguments, see `brew_help("install")`.
#'
#' @param package Name of package(s) (formula or cask)
#' @param cask If `TRUE`, `package` refers to a cask. If `FALSE` (default),
#' `package` refers to a formula.
#' @param force Do not check for previous installations
#' (default: `FALSE`)
#' @param only_dependencies Install only dependencies and not the formula itself
#' (default: `FALSE`)
#' @param keep_tmp Do not delete temporary files created during installation
#' (default: `FALSE`)
#' @inheritDotParams brew_cmd
#'
#' @return A logical value indicating whether or not the installation was a
#' success
#'
#' @export
#'
#' @examples
#' \dontrun{
#' # Install unixodbc
#' brew_install("unixodbc")
#' }
brew_install <- function(package,
                         cask = FALSE,
                         force = FALSE,
                         only_dependencies = FALSE,
                         keep_tmp = FALSE,
                         ...) {
  checkmate::assert_character(
    package,
    min.chars = 1, min.len = 1, any.missing = FALSE
  )
  checkmate::assert_flag(cask)
  checkmate::assert_flag(force)
  checkmate::assert_flag(only_dependencies)
  checkmate::assert_flag(keep_tmp)

  args <- c()

  if (cask) args <- append(args, "--cask")
  if (force) args <- append(args, "--force")
  if (only_dependencies) args <- append(args, "--only-dependencies")
  if (keep_tmp) args <- append(args, "--keep-tmp")

  args <- append(args, package)

  invisible(brew_cmd(cmd = "install", args = args, ...)$status == 0)
}


#' @rdname brew_install
#' @export
#' @examples
#' \dontrun{
#' # Install the Homebrew-compiled version of R
#' brew_install_formula("r")
#' }
brew_install_formula <- function(package, ...) {
  brew_install(package = package, cask = FALSE, ...)
}


#' @rdname brew_install
#' @export
#' @examples
#' \dontrun{
#' # Install RStudio cask
#' brew_install_cask("rstudio")
#' }
brew_install_cask <- function(package, ...) {
  brew_install(package = package, cask = TRUE, ...)
}


#' @rdname brew_install
#' @description `brew_reinstall()` uninstalls and then reinstalls a formula or
#' cask using the same options it was originally installed with, plus any
#' appended options specific to a formula.
#' @param package Name of formula or cask
#' @export
#' @examples
#' \dontrun{
#' # Reinstall unixodbc
#' brew_reinstall("unixodbc")
#' }
brew_reinstall <- function(package, ...) {
  invisible(brew_cmd(cmd = "reinstall", args = c(package), ...)$status == 0)
}


#' @rdname brew_install
#' @description `brew_uninstall()` uninstalls a formula or cask
#' @export
#' @examples
#' \dontrun{
#' # Uninstall unixodbc
#' brew_uninstall("unixodbc")
#' }
brew_uninstall <- function(package, ...) {
  invisible(brew_cmd(cmd = "uninstall", args = c(package), ...)$status == 0)
}