Readonly
commandCommand line options to use when starting the R session.
Readonly
cwd: stringThe current working directory of the R session.
Readonly
env: undefined | {}The environment variables available in the R session.
Readonly
eol: stringThe character to use to mark the end of a line. Is probably always \n
(even on windows).
Readonly
homeThe path to the library directory, use undefined to let R figure that out for itself
Readonly
onCalled when the R session is restarted, this makes only sense if revive
is not set to 'never'
Readonly
pathThe path to the R executable, can be only the executable if it is to be found on the PATH.
Readonly
revive: RShellReviveOptionsIf set, the R session will be restarted if it exits due to an error
Collect lines from the selected streams until the given condition is met or the timeout is reached
This method does allow other listeners to consume the same input
The stream(s) to collect the information from
If the predicate returns true, this will stop the collection and resolve the promise
Configuration for how and when to timeout
Optional
action: (() => void)Event to be performed after all listeners are installed, this might be the action that triggers the output you want to collect
close the current R session, makes the object effectively invalid (can no longer be reopened etc.)
Optional
filesToUnlink: readonly string[]If set, these files will be unlinked before closing the session (e.g., to clean up tempfiles)
true if the kill succeeds, false otherwise
Used to deal with the underlying input-output streams of the R process