Description
Load Both User-Global and Project-Specific R Profile Configurations.
Description
Use rprofile::load() inside a project '.Rprofile' file to ensure that the user-global '.Rprofile' is loaded correctly regardless of its location, and other common resources (in particular 'renv') are also set up correctly.
README.md
rprofile
rprofile stream-lines project .Rprofile
configuration loading.
Installation
rprofile is on CRAN. Install it via
install.packages('rprofile')
Usage
To use the package, add the following as the first line in a project .Rprofile
file:
if (requireNamespace("rprofile", quietly = TRUE)) rprofile::load()
In most cases, that’s it. See the documentation for available parameters to customize the configuration.
At the moment, rprofile performs the following actions, in order, unless disabled via arguments:
- If the project is using an renv environment, it will be activated.
- If the project contains a
.env
file in its current path, the environment variables it contains will be loaded viareadRenviron()
. - The user profile (that is, the file
~/.Rprofile
, or a file set via theR_PROFILE_USER
environment variable) is loaded. Any errors that occur while loading this file will be converted into warnings, andrprofile::load()
will invisibly return whether the file loaded without errors. - If the project is an R package, load it via
pkgload::load_all(export_all = FALSE)
. To avoid disrupting the regular package load order, this action will be deferred until after all default packages (given bygetOption('defaultPackages')
) have been loaded and attached.