# 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](https://github.com/r-lib/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](https://github.com/r-lib/pkgcache)
- Performs all downloads and HTTP queries concurrently.
- Builds and installs packages in parallel.

# Install

Install the package with:

``` r
install.packages("pkgdepends")
```

If you need the development version, install it with

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

# Usage

``` r
library(pkgdepends)
```

## Package references

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

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

See [“Package
references”](https://r-lib.github.io/pkgdepends/reference/pkg_refs.html)
for details.

## Package dependencies

Dependencies of the development version of the cli package:

``` r
pd <- new_pkg_deps("r-lib/pkgcache")
pd$solve()
pd$draw()
```

    ## ✔ Updated metadata database: 3.33 MB in 8 files.
    ## ✔ Updating metadata database ... done
    ## r-lib/pkgcache 2.2.5.9000 [new][bld][cmp][dl] (unknown size)
    ## ├─callr 3.7.6 [new][bld][dl] (104.36 kB)
    ## │ ├─processx 3.8.7 [new][bld][cmp][dl] (165.19 kB)
    ## │ │ ├─ps 1.9.2 [new][bld][cmp][dl] (167.92 kB)
    ## │ │ └─R6 2.6.1 [new][bld][dl] (64.51 kB)
    ## │ └─R6
    ## ├─cli 3.6.5 [new][bld][cmp][dl] (640.24 kB)
    ## ├─curl 7.0.0 [new][bld][cmp][dl] (731.11 kB)
    ## ├─filelock 1.0.3 [new][bld][cmp][dl] (15.44 kB)
    ## ├─jsonlite 2.0.0 [new][bld][cmp][dl] (1.06 MB)
    ## ├─processx
    ## └─R6
    ##
    ## Key:  [new] new | [dl] download | [bld] build | [cmp] compile

See the
[`pkg_deps`](https://r-lib.github.io/pkgdepends/reference/pkg_deps.html)
class for details.

## Package downloads

Downloading all dependencies of a package:

``` r
pdl <- new_pkg_download_proposal("r-lib/cli")
pdl$resolve()
pdl$download()
```

    ## ℹ Getting 1 pkg with unknown size
    ## ✔ Got cli 3.6.5.9000 (source) (852.59 kB)

See the
[`pkg_download_proposal`](https://r-lib.github.io/pkgdepends/reference/pkg_download_proposal.html)
class for details.

## Package installation

Installing or updating a set of package:

``` r
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.5.9000 (source) is the latest build
    ## ℹ Packaging cli 3.6.5.9000
    ## ✔ Packaged cli 3.6.5.9000 (1.8s)
    ## ℹ Building cli 3.6.5.9000
    ## ✔ Built cli 3.6.5.9000 (9.4s)
    ## ✔ Installed cli 3.6.5.9000 (github::r-lib/cli@eef82e9) (34ms)
    ## ✔ Summary:   1 new  in 9.5s

## Dependency resolution

[`pkg_deps`](https://r-lib.github.io/pkgdepends/reference/pkg_deps.html),
[`pkg_download_proposal`](https://r-lib.github.io/pkgdepends/reference/pkg_download_proposal.html)
and
[`pkg_installation_proposal`](https://r-lib.github.io/pkgdepends/reference/pkg_installation_proposal.html)
all resolve their dependencies recursively, to obtain information about
all packages needed for the specified [package
references](https://r-lib.github.io/pkgdepends/reference/pkg_refs.html).
See [“Dependency
resolution”](https://r-lib.github.io/pkgdepends/reference/pkg_resolution.html)
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”](https://r-lib.github.io/pkgdepends/reference/pkg_solution.html)
for details.

## Installation plans

[`pkg_installation_proposal`](https://r-lib.github.io/pkgdepends/reference/pkg_installation_proposal.html)
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”](https://r-lib.github.io/pkgdepends/reference/install_plans.html)
for details.

## Configuration

The details of
[`pkg_deps`](https://r-lib.github.io/pkgdepends/reference/pkg_deps.html),
[`pkg_download_proposal`](https://r-lib.github.io/pkgdepends/reference/pkg_download_proposal.html)
and
[`pkg_installation_proposal`](https://r-lib.github.io/pkgdepends/reference/pkg_installation_proposal.html)
can be tuned with a list of configuration options. See
[“Configuration”](https://r-lib.github.io/pkgdepends/reference/pkg_config.html)
for details.

# Related

- [pak](https://github.com/r-lib/pak) – R package manager
- [pkgcache](https://github.com/r-lib/pkgcache) – Metadata and package
  cache
- [devtools](https://github.com/r-lib/devtools) – Tools for R package
  developers

## Code of Conduct

Please note that the pkgdepends project is released with a [Contributor
Code of
Conduct](https://r-lib.github.io/pkgdepends/dev/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.

# License

MIT (c) RStudio

# Package index

## Configuration

- [`current_config()`](https://r-lib.github.io/pkgdepends/reference/pkg_config.md)
  : pkgdepends configuration

## Package names and references

- [`pkg_refs`](https://r-lib.github.io/pkgdepends/reference/pkg_refs.md)
  : Package references
- [`parse_pkg_refs()`](https://r-lib.github.io/pkgdepends/reference/parse_pkg_refs.md)
  [`parse_pkg_ref()`](https://r-lib.github.io/pkgdepends/reference/parse_pkg_refs.md)
  : Parse package location references
- [`pkg_name_check()`](https://r-lib.github.io/pkgdepends/reference/pkg_name_check.md)
  : Check if an R package name is available.
- [`pkg_rx()`](https://r-lib.github.io/pkgdepends/reference/pkg_rx.md) :
  A set of handy regular expressions related to R packages

## Package dependencies

- [`pkg_resolution`](https://r-lib.github.io/pkgdepends/reference/pkg_resolution.md)
  [`pkg_resolution_result`](https://r-lib.github.io/pkgdepends/reference/pkg_resolution.md)
  : Dependency resolution
- [`pkg_solution`](https://r-lib.github.io/pkgdepends/reference/pkg_solution.md)
  [`pkg_solution_result`](https://r-lib.github.io/pkgdepends/reference/pkg_solution.md)
  : The dependency solver
- [`new_pkg_deps()`](https://r-lib.github.io/pkgdepends/reference/pkg_deps.md)
  : R6 class for package dependency lookup
- [`scan_deps()`](https://r-lib.github.io/pkgdepends/reference/scan_deps.md)
  : Scan R code for dependent packages

## Package downloads

- [`pkg_downloads`](https://r-lib.github.io/pkgdepends/reference/pkg_downloads.md)
  [`pkg_download_result`](https://r-lib.github.io/pkgdepends/reference/pkg_downloads.md)
  : Package downloads
- [`new_pkg_download_proposal()`](https://r-lib.github.io/pkgdepends/reference/pkg_download_proposal.md)
  : R6 class for package downloads

## Package installation

- [`install_plans`](https://r-lib.github.io/pkgdepends/reference/install_plans.md)
  : Installation plans
- [`install_package_plan()`](https://r-lib.github.io/pkgdepends/reference/install_package_plan.md)
  : Perform a package installation plan
- [`new_pkg_installation_plan()`](https://r-lib.github.io/pkgdepends/reference/pkg_installation_plan.md)
  : R6 class for installation from a lock file
- [`new_pkg_installation_proposal()`](https://r-lib.github.io/pkgdepends/reference/pkg_installation_proposal.md)
  : R6 class for package download and installation.

## Package libraries

- [`lib_status()`](https://r-lib.github.io/pkgdepends/reference/lib_status.md)
  : Status of packages in a library

## System requirements

- [`sysreqs_check_installed()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_check_installed.md)
  [`sysreqs_fix_installed()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_check_installed.md)
  : Check if installed packages have all their system requirements
- [`sysreqs_db_list()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_db_list.md)
  : List contents of the system requirements DB, for a platform
- [`sysreqs_db_match()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_db_match.md)
  : Match system requirement descriptions to the database
- [`sysreqs_db_update()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_db_update.md)
  : Update the cached copy of the system requirements database
- [`sysreqs_install_plan()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_install_plan.md)
  : Create an installation plan for system requirements
- [`sysreqs_is_supported()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_is_supported.md)
  : Check if a platform has system requirements support
- [`sysreqs_list_system_packages()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_list_system_packages.md)
  : List installed system packages
- [`sysreqs_platforms()`](https://r-lib.github.io/pkgdepends/reference/sysreqs_platforms.md)
  : List platforms with system requirements support

## Utility functions

- [`as_pkg_dependencies()`](https://r-lib.github.io/pkgdepends/reference/as_pkg_dependencies.md)
  : Shorthands for dependency specifications
- [`current_r_platform()`](https://r-lib.github.io/pkgdepends/reference/default_platforms.md)
  [`default_platforms()`](https://r-lib.github.io/pkgdepends/reference/default_platforms.md)
  : R platforms
- [`is_valid_package_name()`](https://r-lib.github.io/pkgdepends/reference/is_valid_package_name.md)
  : Check whether a package name is valid
- [`pkg_dep_types_hard()`](https://r-lib.github.io/pkgdepends/reference/pkg_dep_types.md)
  [`pkg_dep_types_soft()`](https://r-lib.github.io/pkgdepends/reference/pkg_dep_types.md)
  [`pkg_dep_types()`](https://r-lib.github.io/pkgdepends/reference/pkg_dep_types.md)
  : Possible package dependency types

# Articles

### All vignettes

- [pkgdepends
  HOWTO](https://r-lib.github.io/pkgdepends/articles/pkgdepends-how-to.md):