settings: Project Settings

In slopp/renv: Project Environments for R

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 3.

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.

User-Provided Defaults

It is possible to provide your own global defaults for these options. See config for more details. This can be useful if you'd like to enforce certain project settings within new projects.

Examples

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

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

# cache is turned on by default
renv::settings$use.cache()

# but we can disable it by default
options(renv.config.use.cache = FALSE)
renv::settings$use.cache()

# enable for current project
renv::settings$use.cache(TRUE, persist = FALSE)
renv::settings$use.cache()

slopp/renv documentation built on July 6, 2019, 12:08 a.m.