Configuration of an RShell instance. See DEFAULT_R_SHELL_OPTIONS for the default values used by RShell.

interface RShellOptions {
    commandLineOptions: readonly string[];
    cwd: string;
    env: undefined | ProcessEnv;
    eol: string;
    homeLibPath: undefined | string;
    onRevive: ((code: number, signal: null | string) => void);
    pathToRExecutable: string;
    revive: RShellReviveOptions;
    sessionName: string;
}

Hierarchy (view full)

Hierarchy-Diagram

UML class diagram of RShellOptions

Properties

commandLineOptions: readonly string[]

Command line options to use when starting the R session.

cwd: string

The current working directory of the R session.

env: undefined | ProcessEnv

The environment variables available in the R session.

eol: string

The character to use to mark the end of a line. Is probably always \n (even on windows).

homeLibPath: undefined | string

The path to the library directory, use undefined to let R figure that out for itself

onRevive: ((code: number, signal: null | string) => void)

Called when the R session is restarted, this makes only sense if revive is not set to 'never'

pathToRExecutable: string

The path to the R executable, can be only the executable if it is to be found on the PATH.

If set, the R session will be restarted if it exits due to an error

sessionName: string