Clean a Project

Clean up a project and its associated R libraries.

clean(project = NULL, ..., prompt = interactive())

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.
prompt	Boolean; prompt the user before taking any action? For backwards compatibility, confirm is accepted as an alias for prompt.

Value

The project directory, invisibly. Note that this function is normally called for its side effects.

Details

The following actions will be taken:

• Stale lockfiles (00LOCK-) will be removed.

• Leftover temporary directories in the project library will be removed.

• Non-system packages installed in the system library will be removed.

• Unused packages within the project will be removed.

• Packages within the cache that are no longer used will be removed.

Examples

if (FALSE) {

# clean the current project
renv::clean()

}