renv (version 0.3.0-40)

settings: Settings

Description

Define project-local settings that can be used to adjust the behavior of renv with your particular project.

Usage

settings

Format

An object of class list of length 5.

Settings

ignored.packages

A vector of packages, which should be ignored when attempting to snapshot the project's private library. Note that if a package has already been added to the lockfile, that entry in the lockfile will not be ignored.

external.libraries

A vector of library paths, to be used in addition to the project's own private library. This can be useful if you have a package available for use in some global library, but for some reason renv is not able to install that package (e.g. sources or binaries for that package are not publicly available, or you have been unable to orchestrate the pre-requisites for installing some packages from source on your machine).

use.cache

Use a global cache of R packages. When active, renv will install packages into a global cache, and link packages from the cache into your renv projects as appropriate. This can greatly save on disk space and install time when for R packages which are used across multiple projects in the same environment.

auto.snapshot

Automatically snapshot changes to a project's private library after installing a package with install().

python

The path to a Python binary, to be used by e.g. reticulate for projects requiring the use of Python. Alternatively, if set to TRUE, then renv will create a project-local Python virtual environment and use that. In that case, renv will use whichever version of Python is currently in use by reticulate (if any), or the version of Python requested by RETICULATE_PYTHON otherwise.

Examples

# NOT RUN {
# check the 'ignored.packages' option
renv::settings$ignored.packages()

# ignore the 'tidyverse' package in this project
renv::settings$ignored.packages("tidyverse")

# }