Skip to content

pkgdepends

Package Dependency Resolution, Downloads and Installation

pkgdepends is a toolkit for package dependencies, downloads and installations, to be used in other packages. If you are looking for a package manager, see pak.

Features

  • Look up package dependencies recursively.
  • Visualize package dependencies.
  • Download packages and their dependencies.
  • Install downloaded packages.
  • Includes a dependency solver to find a consistent set of dependencies.
  • Supports CRAN and Bioconductor packages automatically.
  • Supports packages on GitHub and GitLab.
  • Supports packages in git repositories.
  • Supports package bundles or files on the web.
  • Supports local package file and trees.
  • Supports the Remotes entry in the DESCRIPTION file.
  • Caches metadata and downloaded packages via pkgcache
  • Performs all downloads and HTTP queries concurrently.
  • Builds and installs packages in parallel.

Install

Install the package with:

install.packages("pkgdepends")

If you need the development version, install it with

pak::pak("r-lib/pkgdepends")

Usage

Package references

A package reference (ref) specifies a location from which an R package can be obtained from. Examples:

devtools
cran::devtools
bioc::Biobase
r-lib/pkgdepends
https://github.com/r-lib/pkgdepends
local::~/works/shiny

See “Package references” for details.

Package dependencies

Dependencies of the development version of the cli package:

pd <- new_pkg_deps("r-lib/pkgcache")
pd$solve()
pd$draw()
## ✔ Updated metadata database: 2.96 MB in 8 files.
## ✔ Updating metadata database ... done
## r-lib/pkgcache 2.2.3.9000 [new][bld][cmp][dl] (unknown size)
## ├─callr 3.7.6 [new][bld][dl] (104.36 kB)
## │ ├─processx 3.8.4 [new][bld][cmp][dl] (163.98 kB)
## │ │ ├─ps 1.8.0 [new][bld][cmp][dl] (129.49 kB)
## │ │ └─R6 2.5.1 [new][bld][dl] (63.42 kB)
## │ └─R6
## ├─cli 3.6.3 [new][bld][cmp][dl] (569.77 kB)
## ├─curl 5.2.2 [new][bld][cmp][dl] (716.70 kB)
## ├─filelock 1.0.3 [new][bld][cmp][dl] (15.44 kB)
## ├─jsonlite 1.8.8 [new][bld][cmp][dl] (1.05 MB)
## ├─processx
## └─R6
##
## Key:  [new] new | [dl] download | [bld] build | [cmp] compile

See the pkg_deps class for details.

Package downloads

Downloading all dependencies of a package:

pdl <- new_pkg_download_proposal("r-lib/cli")
pdl$resolve()
pdl$download()
## ℹ Getting 1 pkg with unknown size
## ✔ Got cli 3.6.3.9000 (source) (770.67 kB)

See the pkg_download_proposal class for details.

Package installation

Installing or updating a set of package:

lib <- tempfile()
dir.create(lib)
pdi <- new_pkg_installation_proposal(
  "r-lib/cli",
  config = list(library = lib)
)
pdi$solve()
pdi$download()
pdi$install()
## ℹ Getting 1 pkg with unknown size
## ✔ Cached copy of cli 3.6.3.9000 (source) is the latest build
## ℹ Packaging cli 3.6.3.9000
## ✔ Packaged cli 3.6.3.9000 (1.2s)
## ℹ Building cli 3.6.3.9000
## ✔ Built cli 3.6.3.9000 (7.3s)
## ✔ Installed cli 3.6.3.9000 (github::r-lib/cli@d33aeee) (1s)
## ✔ Summary:   1 new  in 8.4s

Dependency resolution

pkg_deps, pkg_download_proposal and pkg_installation_proposal all resolve their dependencies recursively, to obtain information about all packages needed for the specified package references. See “Dependency resolution” for details.

The dependency solver

The dependency solver takes the resolution information, and works out the exact versions of each package that must be installed, such that version and other requirements are satisfied. See “The dependency solver” for details.

Installation plans

pkg_installation_proposal can create installation plans, and then also install them. It is also possible to import installation plans that were created by other tools. See “Installation plans” for details.

Configuration

The details of pkg_deps, pkg_download_proposal and pkg_installation_proposal can be tuned with a list of configuration options. See “Configuration” for details.

Related

  • pak – R package manager
  • pkgcache – Metadata and package cache
  • devtools – Tools for R package developers

Code of Conduct

Please note that the pkgdepends project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

MIT (c) RStudio