pak-config: Environment variables and options that modify the default...

In r-lib/pak: Another Approach to Package Installation

Environment variables and options that modify the default behavior

Description

pak behavior can be finetuned with environment variables and options (as in base::options()).

R options affecting pak's behavior

Ncpus

Set to the desired number of worker processes for package installation. If not set, then pak will use the number of logical processors in the machine.

repos

The CRAN-like repositories to use. See base::options() for details.

pak configuration

Configuration entries (unless noted otherwise on this manual page) have a corresponding environment variable, and a corresponding option.

The environment variable is always uppercase and uses underscores as the word separator. It always has the PKG_ prefix.

The option is typically lowercase, use it uses underscores as the word separator, but it always has the pkg. prefix (notice the dot!).

Some examples:

Config entry name	Env var name	Option name
platforms	PKG_PLATFORMS	pkg.platforms
cran_mirror	PKG_CRAN_MIRROR	pkg.cran_mirror

pak configuration entries

\eval

doc_config()

Notes

From version 0.4.0 pak copies the ⁠PKG_*⁠ environment variables and the ⁠pkg.*⁠ options to the pak subprocess, where they are actually used, so you don't need to restart R or reaload pak after a configuration change.

r-lib/pak documentation built on Nov. 9, 2024, 2:34 a.m.