Learn R Programming

⚠️There's a newer version (1.1.4) of this package.Take me there.

renv

Overview

The renv package helps you create reproducible environments for your R projects. Use renv to make your R projects more:

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 package 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 development version of renv with:

if (!requireNamespace("remotes"))
  install.packages("remotes")

remotes::install_github("rstudio/renv")

Workflow

Use renv::init() to initialize renv with a new or existing project. This will set up your project with a private library, and also make sure to install all of the packages you're using into that library. The packages used in your project will be recorded into a lockfile, called renv.lock.

As you work in your project, you may need to install or upgrade different packages. As these packages are installed, renv will automatically write renv.lock for you. The renv.lock lockfile records the state of your project's private library, and can be used to restore the state of that library as required.

Later, if you need to port your project to a new machine, you can call renv::restore() to reinstall all of the packages as declared in the lockfile.

Learning More

You can browse the package documentation online at https://rstudio.github.io/renv/.

If this is your first time using renv, we strongly recommend reading the Introduction to renv vignette.

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 either ask on the RStudio Community forums.

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.

Copy Link

Version

Install

install.packages('renv')

Monthly Downloads

412,404

Version

0.9.2

License

MIT + file LICENSE

Maintainer

Kevin Ushey

Last Published

December 9th, 2019

Functions in renv (0.9.2)

modify

Open the Lockfile for Editing
paths

Path Customization
snapshot

Snapshot a Project
refresh

Refresh the Local Cache of Available Packages
init

Initialize a Project
purge

Purge Packages from the Cache
project

Retrieve the Active Project
hydrate

Hydrate a Project
settings

Project Settings
rehash

Re-Hash Packages in the renv Cache
install

Install Packages
isolate

Isolate a Project
rebuild

Rebuild the Packages in your Project Library
lockfiles

Lockfiles
load

Load a Project
migrate

Migrate a Project from Packrat to renv
record

Update Package Records in a Lockfile
lockfile

Programmatically Create and Modify a Lockfile
deactivate

Deactivate a Project
remote

Resolve a Remote
remove

Remove Packages
status

Status
update

Update Packages
use_python

Use Python
upgrade

Upgrade renv
renv-package

Project-local Environments for R
revert

Revert Lockfile
restore

Restore a Project
run

Run a Script
equip

Install Required System Libraries
config

User-Level Configuration of renv
clean

Clean a Project
history

View Lockfile History
bootstrap

Bootstrap an renv Installation
consent

Consent to usage of renv
dependencies

Find R Package Dependencies in a Project
activate

Activate a Project
diagnostics

Print a Diagnostics Report