Learn R Programming

renv

Overview

The renv package[^1] helps you create reproducible environments for your R projects. Use renv to make your R projects more isolated, portable and reproducible.

  • Isolated: Installing a new or updated package for one project won’t break your other projects, and vice versa. That’s because renv gives each project its own private library.
  • Portable: Easily transport your projects from one computer to another, even across different platforms. renv makes it easy to install the packages your project depends on.
  • Reproducible: renv records the exact package versions you depend on, and ensures those exact versions are the ones that get installed wherever you go.

Installation

Install the latest version of renv from CRAN with:

install.packages("renv")

Workflow

Use renv::init() to initialize renv in a new or existing project. This will set up a project library, containing all the packages you’re currently using. The packages (and all the metadata needed to reinstall them) are recorded into a lockfile, renv.lock, and a .Rprofile ensures that the library is used every time you open that project.

As you continue to work on your project, you will install and upgrade packages, either using install.packages() and update.packages() or renv::install() and renv::update(). After you’ve confirmed your code works as expected, use renv::snapshot() to record the packages and their sources in the lockfile.

Later, if you need to share your code with someone else or run your code on new machine, your collaborator (or you) can call renv::restore() to reinstall the specific package versions recorded in the lockfile.

Learning more

If this is your first time using renv, we strongly recommend starting with the Introduction to renv vignette: this will help you understand the most important verbs and nouns of renv.

If you have a question about renv, please first check the FAQ to see whether your question has already been addressed. If it hasn’t, please feel free to ask on the Posit Forum.

If you believe you’ve found a bug in renv, please file a bug (and, if possible, a reproducible example) at https://github.com/rstudio/renv/issues.

[^1]: Pronounced “R” “env”

Copy Link

Version

Install

install.packages('renv')

Monthly Downloads

256,559

Version

1.0.11

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

October 12th, 2024

Functions in renv (1.0.11)

isolate

Isolate a project
load

Load a project
remote

Resolve a Remote
rehash

Re-hash packages in the renv cache
refresh

Refresh the local cache of available packages
remove

Remove packages
vendor

Vendor renv in an R package
modify

Modify a Lockfile
project

Retrieve the active project
renv-package

Project-local Environments for R
record

Update package records in a lockfile
run

Run a script
lockfiles

Lockfiles
restore

Restore project library from a lockfile
renv_lockfile_from_manifest

Generate renv.lock from an RStudio Connect manifest.json
paths

Path for storing global state
purge

Purge packages from the cache
retrieve

Retrieve packages
history

View and revert to a historical lockfile
repair

Repair a project
upgrade

Upgrade renv
use_python

Use python
graph

Generate a Package Dependency Graph
snapshot

Record current state of the project library in the lockfile
migrate

Migrate a project from packrat to renv
settings

Project settings
sandbox

The default library sandbox
scaffold

Generate project infrastructure
update

Update packages
status

Report inconsistencies between lockfile, library, and dependencies
activate

Activate or deactivate a project
equip

Install required system libraries
config

User-level settings
dependencies

Find R package dependencies in a project
clean

Clean a project
embed

Capture and re-use dependencies within a .R or .Rmd
install

Install packages
checkout

Checkout a repository
consent

Consent to usage of renv
autoload

Auto-load the active project
diagnostics

Print a diagnostics report
init

Use renv in a project
rebuild

Rebuild the packages in your project library
lockfile-api

Programmatically Create and Modify a Lockfile
lockfile_validate

Validate an renv lockfile against a schema
hydrate

Copy packages from user libraries to a project library
imbue

Imbue an renv Installation