R/install_from_description.R

Defines functions install_if_missing install_from_description

Documented in install_from_description install_if_missing

#' Install missing package from DESCRIPTION
#'
#' @param path path to the DESCRIPTION file
#' @param field DESCRIPTION fields to parse, "Depends", "Imports", "Suggests" by default
#' @param ...  Arguments to be passed to [utils::install.packages()]
#' @export
#' @return Used for side effect. Installs R packages from DESCRIPTION file if missing.
#' @examples
#' \dontrun{
#' # This will install packages on your system
#' dummypackage <- system.file("dummypackage", package = "attachment")
#' # browseURL(dummypackage)
#'
#' install_from_description(path = file.path(dummypackage, "DESCRIPTION"))
#' }

install_from_description <- function(path = "DESCRIPTION", field = c("Depends", "Imports", "Suggests"), ...) {

  to_be_installed <- att_from_description(path = path, field = field)
  install_if_missing(to_be_installed = to_be_installed, ...)
}

#' install  packages if missing
#'
#' @param to_be_installed a character vector containing required packages names
#' @param ...  Arguments to be passed to [utils::install.packages()]
#'
#' @importFrom utils install.packages
#'
#' @export
#' @return Used for side effect. Install missing packages from the character vector input.
#' @examples
#' \dontrun{
#' # This will install packages on your system
#' install_if_missing(c("dplyr", "fcuk", "rusk"))
#' }
#'
install_if_missing <- function(to_be_installed, ...) {
  already_installed <- basename(try(find.package(to_be_installed, quiet = TRUE,lib.loc = .libPaths()), silent = TRUE))
  will_be_installed <- setdiff(to_be_installed, already_installed)

  if ( length(will_be_installed) == 0 ) {
    message("All required packages are installed")
    return(invisible(NULL))
  }
  message("Installation of: ", paste0(will_be_installed, collapse = ", "))

  install.packages(will_be_installed, ...)
}

Try the attachment package in your browser

Any scripts or data that you put into this service are public.

attachment documentation built on June 7, 2023, 5:19 p.m.