Interface RShellSessionOptions

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

Hierarchy (View Summary)

Indexable

  • [key: string]: unknown

Hierarchy-Diagram

UML class diagram of RShellSessionOptions

Properties

commandLineOptions cwd env eol homeLibPath onRevive pathToRExecutable revive

Properties

ReadonlycommandLineOptions

commandLineOptions: readonly string[]

Command line options to use when starting the R session.

Readonlycwd

cwd: string

The current working directory of the R session.

Readonlyenv

env: undefined | ProcessEnv

The environment variables available in the R session.

Readonlyeol

eol: string

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

ReadonlyhomeLibPath

homeLibPath: undefined | string

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

ReadonlyonRevive

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'

ReadonlypathToRExecutable

pathToRExecutable: string

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

Readonlyrevive

revive: RShellReviveOptions

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

Settings

Member Visibility

On This Page

Properties