rcmd {callr} | R Documentation |
Run an R CMD command form within R. This will usually start another R process, from a shell script.
rcmd(cmd, cmdargs = character(), libpath = .libPaths(), repos = c(getOption("repos"), c(CRAN = "https://cloud.r-project.org")), stdout = NULL, stderr = NULL, echo = FALSE, show = FALSE, callback = NULL, block_callback = NULL, spinner = show && interactive(), system_profile = FALSE, user_profile = FALSE, env = rcmd_safe_env(), timeout = Inf, wd = ".", fail_on_status = FALSE) rcmd_safe(cmd, cmdargs = character(), libpath = .libPaths(), repos = c(getOption("repos"), c(CRAN = "https://cloud.r-project.org")), stdout = NULL, stderr = NULL, echo = FALSE, show = FALSE, callback = NULL, block_callback = NULL, spinner = show && interactive(), system_profile = FALSE, user_profile = FALSE, env = rcmd_safe_env(), timeout = Inf, wd = ".", fail_on_status = FALSE)
cmd |
Command to run. See |
cmdargs |
Command line arguments. |
libpath |
The library path. |
repos |
The repos option. If |
stdout |
Optionally a file name to send the standard output to. |
stderr |
Optionally a file name to send the standard error to. |
echo |
Whether to echo the complete command run by |
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 |
wd |
Working directory to use for running the command. Defaults to the current working directory. |
fail_on_status |
Whether to throw an R error if the command returns with a non-zero status code. By default no error is thrown. |
Starting from callr
2.0.0, rcmd()
has safer defaults, the same as
the rcmd_safe()
default values. Use rcmd_copycat()
for the old
defaults.
A list with the command line $command
),
standard output ($stdout
), standard error (stderr
),
exit status ($status
) of the external R CMD
command, and
whether a timeout was reached ($timeout
).
Other R CMD commands: rcmd_bg
,
rcmd_copycat
## Not run: rcmd("config", "CC") ## End(Not run)