Provide standard messaging for missing package dependencies

Source: R/helpers.R

This provides a standard message format for missing packages, e.g., detected via requireNamespace.

.requireNamespace(
  pkg = "methods",
  minVersion = NULL,
  stopOnFALSE = FALSE,
  messageStart = paste0(pkg, if (!is.null(minVersion)) paste0("(>=", minVersion, ")"),
    " is required. Try: ")
)

Arguments

pkg

Character string indicating name of package required

minVersion

Character string indicating minimum version of package that is needed

stopOnFALSE

Logical. If TRUE, this function will create an error (i.e., stop) if the function returns FALSE; otherwise it simply returns FALSE

messageStart

A character string with a prefix of message to provide

Value

A logical or stop if the namespace is not available to be loaded.