User-Level Configuration of renvSource:
Configure different behaviors of
For a given configuration option:
If an R option of the form
renv.config.<name>is available, then that option's value will be used;
If an environment variable of the form
RENV_CONFIG_<NAME>is available, then that option's value will be used;
Otherwise, the default for that particular configuration value is used.
Any periods (
.)s in the option name are transformed into underscores (
in the environment variable name, and vice versa. For example, the
auto.snapshot could be configured as:
options(renv.config.auto.snapshot = <...>)
Sys.setenv(RENV_CONFIG_AUTO_SNAPSHOT = <...>)
Note that if both the R option and the environment variable are defined, the R option will be used instead. Environment variables can be more useful when you want a particular configuration to be automatically inherited by child processes; if that behavior is not desired, then the R option may be preferred.
If you want to set and persist these options across multiple projects, it is
recommended that you set them in a a startup
.Renviron file; e.g. in your
~/.Renviron, or in the R installation's
etc/Rprofile.site file. See
Startup for more details.
Configuration options can also be set within the project
be aware the options should be set before
renv configuration options are available:
Automatically prompt the user to activate the current project, if it does not appear to already be activated? This is mainly useful to help ensure that calls to
renv::restore() use the project library. See
?renv::activate for more details.
renv auto-loader? When
renv will not not automatically load a project containing an
renv autoloader within its
.Rprofile. In addition,
renv will not write out the project auto-loader in calls to
Automatically snapshot changes to the project library after a new package is installed?
The default Bitbucket host to be used during package retrieval.
The method to use when attempting to copy directories. See Copy Methods for more information.
The amount of time to spend (in seconds) when attempting to download a file. Only applicable when the
curl downloader is used.
The number of times to attempt re-downloading a file, when transient download errors occur. Only applicable when the
curl downloader is used.
Enable the global
renv package cache? When active,
renv will install packages into a global cache, and link or copy packages from the cache into your R library as appropriate. This can greatly save on disk space and install time when R packages are shared across multiple projects in the same environment.
Symlink packages from the global
renv package cache into your project library? When
renv will use symlinks (or, on Windows, junction points) to reference packages installed in the cache. Set this to
FALSE if you'd prefer to copy packages from the cache into your project library. Enabled by default, except on Windows where this feature is only enabled if the project library and global package cache are on the same volume.
renv APIs require the enumeration of your project's R package dependencies. This option controls how errors that occur during this enumeration are handled. By default, errors are reported but are non-fatal. Set this to
"fatal" to force errors to be fatal, and
"ignored" to ignore errors altogether. See
dependencies() for more details.
library(renv) is called, should its exports be placed on the search path? Set this to
FALSE to avoid issues that can arise with, for example,
base::load(). In general, we recommend referencing
renv functions from its namespace explicitly; e.g. prefer
By default, all exported
renv functions are attached and placed on the search path, for backwards compatibility with existing scripts using
A character vector of external libraries, to be used in tandem with your projects. Be careful when using external libraries: it's possible that things can break within a project if the version(s) of packages used in your project library happen to be incompatible with packages in your external libraries; for example, if your project required
xyz 1.0 but
xyz 1.1 was present and loaded from an external library. Can also be an R function that provides the paths to external libraries. Library paths will be expanded via
.expand_R_libs_env_var() as necessary.
renv file-backed cache? When enabled,
renv will cache the contents of files that are read (e.g. DESCRIPTION files) in memory, thereby avoiding re-reading the file contents from the filesystem if the file has not changed.
renv uses the file
mtime to determine if the file has changed; consider disabling this if
mtime is unreliable on your system.
The default GitHub host to be used during package retrieval.
The default GitLab host to be used during package retrieval.
A character vector of library paths, to be used by
hydrate() when attempting to hydrate projects. When empty, the default set of library paths (as documented in
?hydrate) are used instead. See
hydrate() for more details.
Should downloaded package archives be built (via
R CMD build) before installation? When TRUE, package vignettes will also be built as part of package installation. Because building packages before installation may require packages within 'Suggests' to be available, this option is not enabled by default.
renv read a package's
Remotes: field when determining how package dependencies should be installed?
Allow for a set of 'shortcuts' when installing packages with renv? When enabled, if
renv discovers that a package to be installed is already available within the user or site libraries, then it will install a local copy of that package.
DEPRECATED: Please use
Perform a transactional install of packages during install and restore? When enabled,
renv will first install packages into a temporary library, and later copy or move those packages back into the project library only if all packages were successfully downloaded and installed. This can be useful if you'd like to avoid mutating your project library if installation of one or more packages fails.
Be verbose when installing R packages from sources? When
renv will stream any output generated during package build + installation to the console.
Use interprocess locks when invoking methods which might mutate the project library? Enable this to allow multiple processes to use the same
renv project, while minimizing risks relating to concurrent access to the project library. Disable this if you encounter locking issues. Locks are stored as files within the project at
renv/lock; if you need to manually remove a stale lock you can do so via
unlink("renv/lock", recursive = TRUE).
Attempt to download binaries from MRAN during restore? See
vignette("mran", package = "renv") for more details.
Use the pak package to install packages?
Override the R package repositories used during
restore()? Primarily useful for deployment / continuous integration, where you might want to enforce the usage of some set of repositories over what is defined in
renv.lock or otherwise set by the R session.
Boolean; enable RSPM integration for
renv projects? When
renv will attempt to transform the repository URLs used by RSPM into binary URLs as appropriate for the current platform. Set this to
FALSE if you'd like to continue using source-only RSPM URLs, or if you find that
renv is improperly transforming your repository URLs.
Enable sandboxing for
renv projects? When active,
renv will attempt to sandbox the system library, preventing non-system packages installed in the system library from becoming available in
renv projects. (That is, only packages with priority
"recommended", as reported by
installed.packages(), are made available.)
Sandboxing is done by linking or copying system packages into a separate library path, and then instructing R to use that library path as the system library path. In some environments, this action can take a large amount of time -- in such a case, you may want to disable the renv sandbox.
renv shims be installed on package load? When enabled,
renv will install its own shims over the functions
remove.packages(), delegating these functions to
remove() as appropriate.
Validate R package dependencies when calling snapshot? When
renv will attempt to diagnose potential issues in the project library before creating
renv.lock -- for example, if a package installed in the project library depends on a package which is not currently installed.
Be quiet during startup? When set,
renv will not display the typical
Project <path> loaded. [renv <version>] banner on startup.
Check that the project library is synchronized with the lockfile on load?
Check for package updates when the session is initialized? This can be useful if you'd like to ensure that your project lockfile remains up-to-date with packages as they are released on CRAN.
Check for package updates in parallel? This can be useful when a large number of packages installed from non-CRAN remotes are installed, as these packages can then be checked for updates in parallel.
Load the user R environ (typically located at
renv is loaded?
Include the user library on the library paths for your projects? Note that this risks breaking project encapsulation and is not recommended for projects which you intend to share or collaborate on with other users. See also the caveats for the
Load the user R profile (typically located at
renv is loaded? This is disabled by default, as running arbitrary code from the the user
~/.Rprofile could risk breaking project encapsulation. If your goal is to set environment variables that are visible within all
renv projects, then placing those in
~/.Renviron is often a better choice. Defaults to
If you find that
renv is unable to copy some directories in your
environment, you may want to try setting the
copy.method option. By
renv will try to choose a system tool that is likely to succeed in
copying files on your system --
robocopy on Windows, and
cp on Unix.
renv will also instruct these tools to preserve timestamps and attributes
when copying files. However, you can select a different method as
The following methods are supported:
|Use R's built-in |
You can also provide a custom copy method if required; e.g.
renv will always first attempt to copy a directory first to a
temporary path within the target folder, and then rename that temporary path
to the final target destination. This helps avoid issues where a failed
attempt to copy a directory could leave a half-copied directory behind
in the final location.
For settings that should persist alongside a particular project, the various settings available in settings can be used.
# disable automatic snapshots options(renv.config.auto.snapshot = FALSE) # disable with environment variable Sys.setenv(RENV_CONFIG_AUTO_SNAPSHOT = FALSE)