renviron_d {startup} | R Documentation |
Load .Renviron.d and .Rprofile.d directories during the R startup process
Description
Initiates R using all files under ‘.Renviron.d/’ and / or ‘.Rprofile.d/’ directories (or in subdirectories thereof).
Usage
renviron_d(
sibling = FALSE,
all = FALSE,
unload = FALSE,
skip = NA,
dryrun = NA,
debug = NA,
paths = NULL
)
rprofile_d(
sibling = FALSE,
all = FALSE,
check = NA,
unload = FALSE,
skip = NA,
on_error = c("error", "warning", "immediate.warning", "message", "ignore"),
dryrun = NA,
debug = NA,
paths = NULL
)
startup(
sibling = FALSE,
all = FALSE,
on_error = c("error", "warning", "immediate.warning", "message", "ignore"),
keep = c("options"),
check = NA,
unload = TRUE,
skip = NA,
encoding = getOption("encoding"),
dryrun = NA,
debug = dryrun
)
Arguments
sibling |
If |
all |
If |
unload |
If |
skip |
If |
dryrun |
If |
debug |
If |
paths |
(internal) character vector of directories. |
check |
If |
on_error |
Action taken when an error is detected when sourcing an Rprofile file. It is not possible to detect error in Renviron files; they are always ignored with a message that cannot be captured. |
keep |
Specify what information should remain after this function
complete. The default is to keep |
encoding |
The encodingto use when parsing the R startup files.
See |
Details
The above is done in addition the ‘.Renviron’ and ‘.Rprofile’ files that are supported by the built-in startup process of R.
Functions
-
renviron_d()
: Initiate using ‘.Renviron.d/’ files -
rprofile_d()
: Initiate using ‘.Rprofile.d/’ files -
startup()
:renviron_d()
followed byrprofile_d()
and then the package is unloaded
User-specific installation
In order for ‘.Rprofile.d’ and ‘.Renviron.d’ directories to be
included during the R startup process, a user needs to add
startup::startup()
to ‘~/.Rprofile’. Adding this can also be done
by calling install()
once.
Site-wide installation
An alternative to having each user add startup::startup()
in their own
‘~/.Rprofile’ file, is to add it to the site-wide ‘Rprofile.site’
file (see ?Startup).
The advantage of such a site-wide installation, is that the users do not
have to have a ‘.Rprofile’ file for ‘.Rprofile.d’ and
‘.Renviron.d’ directories to work.
For this to work for all users automatically, the startup package
should also be installed in the site-wide library.
Examples
## Not run:
# The most common way to use the package is to add
# the following call to the ~/.Rprofile file.
startup::startup()
# To process ~/.Renviron.d/ files, and then any ./.Renviron.d/ files,
# followed by ~/.Rprofile.d/ files, and then any ./.Rprofile.d/ files,
# add the following call to the ~/.Rprofile file.
startup::startup(all = TRUE)
# For finer control of on exactly what files are used
# functions renviron_d() and rprofile_d() are also available:
# Initiate first .Renviron.d/ found on search path
startup::renviron_d()
# Initiate all .Rprofile.d/ directories found on the startup search path
startup::rprofile_d(all = TRUE)
## End(Not run)