r: Evaluate an expression in another R session

Description Usage Arguments Details Value Error handling See Also Examples

View source: R/eval.R

Description

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:

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
r(func, args = list(), libpath = .libPaths(),
  repos = default_repos(), stdout = NULL, stderr = NULL,
  poll_connection = TRUE, error = getOption("callr.error", "error"),
  cmdargs = c("--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 = default_repos(), stdout = NULL, stderr = NULL,
  poll_connection = TRUE, error = getOption("callr.error", "error"),
  cmdargs = c("--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, ...)

Arguments

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 :: notation. The environment of the function is set to .GlobalEnv before passing it to the child process. Because of this, it is good practice to create an anonymous function and pass that to callr, instead of passing a function object from a (base or other) package. In particular

r(.libPaths)

does not work, because .libPaths is defined in a special environment, but

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 NULL, then no repos option is set. This options is only used if user_profile or system_profile is set FALSE, as it is set using the system or the user profile.

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 --slave option (the default), then the commands are not echoed and will not be shown in the standard output. Also note that you need to call print() explicitly to show the output of the command(s).

stderr

The name of the file the standard error of the child R process will be written to. In particular message() sends output to the standard error. If nothing was sent to the standard error, then this file will be empty. This argument can be the same file as stdout, in which case they will be correctly interleaved. If this is the string "2>&1", then standard error is redictd to standard output.

poll_connection

Whether to have a control connection to the process. This is used to transmit messages from the subprocess to the parent.

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 c("-f", rscript) is appended to this, rscript is the name of the script file to run. This contains a call to the supplied function and some error handling code.

show

Logical, whether to show the standard output on the screen while the child process is running. Note that this is independent of the stdout and stderr arguments. The standard error is not shown currently.

callback

A function to call for each line of the standard output and standard error from the child process. It works together with the show option; i.e. if show = TRUE, and a callback is provided, then the output is shown of the screen, and the callback is also called.

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 show = TRUE and the R session is interactive.

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 system_command_timeout_error error is thrown. Inf means no timeout.

...

Extra arguments are passed to processx::run().

Details

The pre-2.0.0 r() function is called r_copycat() now.

Value

Value of the evaluated expression.

Error handling

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:

The default error behavior can be also set using the callr.error option. This is useful to debug code that uses callr.

See Also

Other callr functions: r_copycat, r_vanilla

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# Workspace is empty
r(function() ls())

# library path is the same by default
r(function() .libPaths())
.libPaths()

## End(Not run)

r-pkgs/callr documentation built on March 24, 2019, 8:37 p.m.