getDepList: Functions to Retrieve Dependency Information

Description

These functions retrieve information about the dependencies of a package or a dependency matrix, resulting in a DependsList object.

Given a dependency matrix, getDepList() creates a DependsList object for that package. That object includes the dependencies for that matrix, which ones are installed, which unresolved dependencies were found online, which unresolved dependencies were not found online, and any R dependencies.

pkgDepends() for convenience takes a package name, builds a dependency matrix and then returns a corresponding getDepList().

Usage

getDepList(depMtrx, instPkgs, recursive = TRUE, local = TRUE,
           reduce = TRUE, lib.loc = NULL)
pkgDepends(pkg, recursive = TRUE, local = TRUE, reduce = TRUE,
           lib.loc = NULL)

Arguments

depMtrx

a dependency matrix as from package.dependencies().

pkg

the name of the package

instPkgs

a matrix specifying all packages installed on the local system, as from installed.packages

recursive

whether or not to include indirect dependencies.

local

whether or not to search only locally

reduce

whether or not to collapse all sets of dependencies to a minimal value

lib.loc

what libraries to use when looking for installed packages. NULL indicates all library directories in the current .libPaths(). Note that lib.loc is not used in getDepList() and deprecated there.

Value

An object of S3 class "DependsList", which is a list with components
DependsA vector of the dependencies for this package.
InstalledA vector of the dependencies which have been satisfied by the currently installed packages.
FoundA list representing the dependencies which are not in Installed but were found online. This list has element names which are the URLs for the repositories in which packages were found and the elements themselves are vectors of package names which were found in the respective repositories. If local = TRUE, the Found element will always be empty.
NotFound...
RAny R version dependencies.

Details

The convenience function pkgDepends(pkg) queries installed.packages and generates a dependency matrix, calling getDepList with this information and returning the result.

If recursive is TRUE, any package that is specified as a dependency will in turn have its dependencies included (and so on), these are known as indirect dependencies. If recursive is FALSE, only the dependencies directly stated by the package will be used.

If local is TRUE, the system will only look at the user's local install and not online to find unresolved dependencies.

If reduce is TRUE, the system will collapse the fields in the DependsList object such that a minimal set of dependencies are specified (for instance if there was foo, foo (>= 1.0.0), foo (>= 1.3.0), it would only return foo (>= 1.3.0)).

Examples

Run this code

pkgDepends("tools", local = FALSE)