@eagleoutice/flowr - v2.10.2
    Preparing search index...

    Interface RShellOptions

    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: ProcessEnv | undefined;
        eol: string;
        homeLibPath: string | undefined;
        onRevive: (code: number, signal: string | null) => void;
        pathToRExecutable: string;
        revive: RShellReviveOptions;
        sessionName: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

    Hierarchy-Diagram

    UML class diagram of RShellOptions
    Index

    Properties

    commandLineOptions cwd env eol homeLibPath onRevive pathToRExecutable revive sessionName

    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: ProcessEnv | undefined

    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: string | undefined

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

    onRevive: (code: number, signal: string | null) => 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.

    revive: RShellReviveOptions

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

    sessionName: string

    Settings

    Member Visibility

    On This Page

    Properties