Configuration entries for several pkgdepends classes.
Details
pkgdepends configuration is set from several source. They are, in the order of preference:
Function arguments, e.g. the
config
argument ofnew_pkg_installation_proposal()
.Global options, set via
options()
. The name of the global option is thepkg.
prefix plus the name of the pkgdepends configuration entry. E.g.pkg.platforms
.Environment variables. The name of the environment variable is the
PKG_
prefix, plus the name of the pkgdepends configuration entry, in uppercase. E.g.PKG_PLATFORMS
.Default values.
Not all classes use all entries. E.g. a pkg_download_proposal
is not
concerned about package libraries, so it'll ignore the library
configuration entry.
Call current_config()
to print the current configuration.
Configuration entries
build_vignettes
: Whether to build vignettes for package trees. This is only used if the package is obtained from a package tree, and not from a source (or binary) package archive. By default vignettes are not built in this case. If you set this toTRUE
, then you need to make sure that the vignette builder packages are available, as these are not installed by default currently.cache_dir
: Directory to download the packages to. Defaults to a temporary directory within the R session temporary directory, seebase::tempdir()
.cran_mirror
: CRAN mirror to use. Defaults to therepos
option (seebase::options()
), if that's not set thenhttps://cran.rstudio.com
.dependencies
: Dependencies to consider or download or install. Defaults to the hard dependencies, seepkg_dep_types_hard()
. The following values are supported in thePKG_DEPENDENCIES
environment variable:"TRUE"
,"FALSE"
,"NA"
, or a semicolon separated list of dependency types. Seeas_pkg_dependencies()
for details.library
: Package library to install packages to. It is also used for already installed packages when considering dependencies in dependency lookup or package installation. Defaults to the first path in.libPaths()
.metadata_cache_dir
: Location of metadata replica ofpkgcache::cranlike_metadata_cache
. Defaults to a temporary directory within the R session temporary directory, seebase::tempdir()
.metadata_update_after
: A time interval as a difftime object. pkgdepends will update the metadata cache if it is older than this. The default is one day. ThePKG_METADATA_UPDATE_AFTER
environment variable may be set in seconds (s
suffix), minutes (m
suffix), hours (h
suffix), or days (d
suffix). E.g:1d
means one day.package_cache_dir
: Package cache location ofpkgcache::package_cache
. The default is the pkgcache default.platforms
: Character vector of platforms to download or install packages for. Seedefault_platforms()
for possible platform names. Defaults to the platform of the current R session, plus"source"
.r_versions
: Character vector, R versions to download or install packages for. It defaults to the current R version.sysreqs
: Whether to look up and install system requirements. By default this isTRUE
if theCI
environment variable is set and the operating system is a supported Linux distribution: CentOS, Debian, Fedora, openSUSE, RedHat Linux, Ubuntu Linux or SUSE Linux Enterprise. The default will change as new platforms gain system requirements support.sysreqs_dry_run
: IfTRUE
, then pkgdepends only prints the system commands to install system requirements, but does not execute them.sysreqs_rspm_repo_id
: Posit Package Manager (formerly RStudio Package Manager) repository id to use for CRAN system requirements lookup. Defaults to theRSPM_REPO_ID
environment variable, if set. If not set, then it defaults to1
.sysreqs_rspm_url
: Root URL of Posit Package Manager (formerly RStudio Package Manager) for system requirements lookup. By default theRSPM_ROOT
environment variable is used, if set. If not set, it defaults tohttps://packagemanager.posit.co
.sysreqs_sudo
: Whether to usesudo
to install system requirements, on Unix. By default it isTRUE
on Linux if the effective user id of the current process is not theroot
user.sysreqs_verbose
: Whether to echo the output of system requirements installation. Defaults toTRUE
if theCI
environment variable is set.use_bioconductor
: Whether to automatically use the Bioconductor repositories. Defaults toTRUE
.windows_archs
: Character scalar specifying which architectures to download/install for on Windows. Its possible values are:"prefer-x64"
: Generally prefer x64 binaries. If the current R session isx64
, then we download/install x64 packages. (These packages might still be multi-architecture binaries!) If the current R session isi386
, then we download/install packages for both architectures. This might mean compiling packages from source if the binary packages are forx64
only, like the CRAN Windows binaries for R 4.2.x currently."prefer-x64"
is the default for R 4.2.0 and later."both"
: Always download/install packages for bothi386
andx64
architectures. This might need compilation from source if the available binaries are forx64
only, like the CRAN Windows binaries for R 4.2.x currently."both"
is the default for R 4.2.0 and earlier.