r {callr} | R Documentation |
From callr
version 2.0.0, r()
is equivalent to r_safe()
, and
tries to set up a less error prone execution environment. In particular:
It makes sure that at least one reasonable CRAN mirror is set up.
Adds some command line arguments are added to avoid saving
.RData
files, etc.
Ignores the system and user profiles.
Various environment variables are set: CYGWIN
to avoid
warnings about DOS-style paths, R_TESTS
to avoid issues
when callr
is invoked from unit tests, R_BROWSER
and R_PDFVIEWER
to avoid starting a browser or a PDF viewer.
See rcmd_safe_env()
.
r(func, args = list(), libpath = .libPaths(), repos = c(getOption("repos"), c(CRAN = "https://cloud.r-project.org")), stdout = NULL, stderr = NULL, error = getOption("callr.error", "error"), cmdargs = c("--no-site-file", "--no-environ", "--slave", "--no-save", "--no-restore"), show = FALSE, callback = NULL, block_callback = NULL, spinner = show && interactive(), system_profile = FALSE, user_profile = FALSE, env = rcmd_safe_env(), timeout = Inf) r_safe(func, args = list(), libpath = .libPaths(), repos = c(getOption("repos"), c(CRAN = "https://cloud.r-project.org")), stdout = NULL, stderr = NULL, error = getOption("callr.error", "error"), cmdargs = c("--no-site-file", "--no-environ", "--slave", "--no-save", "--no-restore"), show = FALSE, callback = NULL, block_callback = NULL, spinner = show && interactive(), system_profile = FALSE, user_profile = FALSE, env = rcmd_safe_env(), timeout = Inf)
func |
Function object to call in the new R process.
The function should be self-contained and only refer to
other functions and use variables explicitly from other packages
using the r(.libPaths) does not work, because r(function() .libPaths()) works just fine. |
args |
Arguments to pass to the function. Must be a list. |
libpath |
The library path. |
repos |
The repos option. If |
stdout |
The name of the file the standard output of
the child R process will be written to.
If the child process runs with the |
stderr |
The name of the file the standard error of
the child R process will be written to.
In particular |
error |
What to do if the remote process throws an error. See details below. |
cmdargs |
Command line arguments to pass to the R process.
Note that |
show |
Logical, whether to show the standard output on the screen
while the child process is running. Note that this is independent
of the |
callback |
A function to call for each line of the standard
output and standard error from the child process. It works together
with the |
block_callback |
A function to call for each block of the standard output and standard error. This callback is not line oriented, i.e. multiple lines or half a line can be passed to the callback. |
spinner |
Whether to show a calming spinner on the screen while
the child R session is running. By default it is shown if
|
system_profile |
Whether to use the system profile file. |
user_profile |
Whether to use the user's profile file. |
env |
Environment variables to set for the child process. |
timeout |
Timeout for the function call to finish. It can be a
base::difftime object, or a real number, meaning seconds.
If the process does not finish before the timeout period expires,
then a |
The pre-2.0.0 r()
function is called r_copycat()
now.
Value of the evaluated expression.
callr
handles errors properly. If the child process throws an
error, then callr
throws an error with the same error message
in the parent process.
The error
expert argument may be used to specify a different
behavior on error. The following values are possible:
error
is the default behavior: throw an error in the parent, with
the same error message. In fact the same error object is thrown again.
stack
also throws an error in the parent, but the error
is of a special kind, class callr_error
, and it contains
both the original error object, and the call stack of the child,
as written out by utils::dump.frames()
.
debugger
is similar to stack
, but in addition
to returning the complete call stack, it also start up a debugger
in the child call stack, via utils::debugger()
.
The default error behavior can be also set using the callr.error
option. This is useful to debug code that uses callr
.
Other callr functions: r_copycat
,
r_vanilla
## Not run: # Workspace is empty r(function() ls()) # library path is the same by default r(function() .libPaths()) .libPaths() ## End(Not run)