R/packageDependencies.R

Defines functions packageDependencies

Documented in packageDependencies

#' Package dependencies
#'
#' @export
#' @note Updated 2022-10-20.
#'
#' @param pkg `character(1)`.
#' Package name.
#'
#' @param recursive `logical(1)`.
#' Check dependencies recursively.
#'
#' @return `character`.
#' Names of dependency packages.
#'
#' @examples
#' ## > packageDependencies("stats")
packageDependencies <- function(pkg, recursive = TRUE) {
    stopifnot(
        .requireNamespaces(c("BiocManager", "tools", "withr")),
        .isString(pkg),
        .isFlag(recursive)
    )
    withr::with_options(
        new = list(
            "repos" = append(
                x = getOption("repos"),
                values = BiocManager::repositories()
            )
        ),
        code = {
            out <- tools::package_dependencies(
                packages = pkg,
                db = NULL,
                which = c("Depends", "Imports", "LinkingTo"),
                recursive = recursive,
                reverse = FALSE
            )
            out <- out[[1L]]
            out
        }
    )
}
mjsteinbaugh/devtools documentation built on Jan. 5, 2024, 11:09 a.m.