status: Status

In wnattt/renv: Project Environments

Description

Report differences between the project's lockfile and the current state of the project's library (if any).

Usage

status(project = NULL, ..., library = NULL, lockfile = NULL, cache = FALSE)

Arguments

project	The project directory. If NULL, then the active project will be used. If no project is currently active, then the current working directory is used instead.
...	Unused arguments, reserved for future expansion. If any arguments are matched to ..., renv will signal an error.
library	The library paths. By default, the library paths associated with the requested project are used.
lockfile	The path to a lockfile. By default, the project lockfile (called renv.lock) is used.
cache	Boolean; perform diagnostics on the global package cache? When TRUE, renv will validate that the packages installed into the cache are installed at the expected + proper locations, and validate the hashes used for those storage locations.

Value

This function is normally called for its side effects.

Examples

## Not run: 

# disable automatic snapshots
auto.snapshot <- getOption("renv.config.auto.snapshot")
options(renv.config.auto.snapshot = FALSE)

# initialize a new project (with an empty R library)
renv::init(bare = TRUE)

# install digest 0.6.19
renv::install("digest@0.6.19")

# save library state to lockfile
renv::snapshot()

# remove digest from library
renv::remove("digest")

# check library status
renv::status()

# restore lockfile, thereby reinstalling digest 0.6.19
renv::restore()

# restore automatic snapshots
options(renv.config.auto.snapshot = auto.snapshot)


## End(Not run)

wnattt/renv documentation built on Dec. 23, 2021, 5:19 p.m.