Package index • renv

Core Workflow

These functions are the bread and butter of renv usage, and make up the bulk of day-to-day renv usage.

init(): Use renv in a project
status(): Report inconsistencies between lockfile, library, and dependencies
snapshot(): Record current state of the project library in the lockfile
restore(): Restore project library from a lockfile

Package Management

install(): Install packages
update(): Update packages
remove(): Remove packages

Configuration

config: User-level settings
settings: Project settings

Project Management

activate() deactivate(): Activate or deactivate a project
dependencies(): Find R package dependencies in a project
load(): Load a project
migrate(): Migrate a project from packrat to renv
paths: Path for storing global state
project(): Retrieve the active project
upgrade(): Upgrade renv

Library Management

rebuild(): Rebuild the packages in your project library
repair(): Repair a project
clean(): Clean a project

Lockfile Management

lockfile_create() lockfile_read() lockfile_write() lockfile_modify(): Lockfiles
lockfile_validate(): Validate an renv lockfile against a schema
record(): Update package records in a lockfile
remote(): Resolve a Remote
modify(): Modify a Lockfile
history() revert(): View and revert to a historical lockfile
scaffold(): Generate project infrastructure

Package Cache

isolate(): Isolate a project
rehash(): Re-hash packages in the renv cache
purge(): Purge packages from the cache

Python Integration

use_python(): Use python

Miscellaneous

autoload(): Auto-load the active project
checkout(): Checkout a repository
consent(): Consent to usage of renv
diagnostics(): Print a diagnostics report
refresh(): Refresh the local cache of available packages
run(): Run a script
sysreqs(): R System Requirements
embed() use(): Capture and re-use dependencies within a .R, .Rmd or .qmd