activate {renv} | R Documentation |
Activate or deactivate a project
Description
activate()
enables renv for a project in both the current session and
in all future sessions. You should not generally need to call activate()
yourself as it's called automatically by init()
, which is the best
way to start using renv in a new project.
activate()
first calls scaffold()
to set up the project
infrastructure. Most importantly, this creates a project library and adds a
an auto-loader to .Rprofile
to ensure that the project library is
automatically used for all future instances of the project. It then restarts
the session to use that auto-loader.
deactivate()
removes the infrastructure added by activate()
, and
restarts the session. By default it will remove the auto-loader from the
.Rprofile
; use clean = TRUE
to also delete the lockfile and the project
library.
Usage
activate(project = NULL, profile = NULL)
deactivate(project = NULL, clean = FALSE)
Arguments
project |
The project directory. If |
profile |
The profile to be activated. See
|
clean |
If |
Value
The project directory, invisibly. Note that this function is normally called for its side effects.
Temporary deactivation
If you need to temporarily disable autoload activation you can set
the RENV_CONFIG_AUTOLOADER_ENABLED
envvar, e.g.
Sys.setenv(RENV_CONFIG_AUTOLOADER_ENABLED = "false")
.
Examples
## Not run:
# activate the current project
renv::activate()
# activate a separate project
renv::activate(project = "~/projects/analysis")
# deactivate the currently-activated project
renv::deactivate()
## End(Not run)