Class RShell

constructor

• new RShell(options?): RShell

• Parameters

  • Optionaloptions: Partial<RShellOptions>

  Returns RShell

Readonlyoptions

clearEnvironment

• clearEnvironment(): void

• clears the R environment using the rm command.

  Returns void

close

• close(): boolean

• Close the current R session, makes the object effectively invalid (can no longer be reopened etc.)

  Returns boolean

  true if the operation succeeds, false otherwise

injectLibPaths

• injectLibPaths(...paths): void

• Parameters

  • Rest...paths: readonly string[]

  Returns void

isPackageInstalled

• isPackageInstalled(packageName): Promise<boolean>

• checks if a given package is already installed on the system!

  Parameters

  • packageName: string

  Returns Promise<boolean>

obtainTmpDir

• obtainTmpDir(): Promise<string>

• Obtain the temporary directory used by R. Additionally, this marks the directory for removal when the shell exits.

  Returns Promise<string>

sendCommand

• sendCommand(command): void

• sends the given command directly to the current R session will not do anything to alter input markers!

  Parameters

  • command: string

  Returns void

sendCommands

• sendCommands(...commands): void

• execute multiple commands in order

  Parameters

  • Rest...commands: readonly string[]

  Returns void

  See

  sendCommand

sendCommandWithOutput

• sendCommandWithOutput(command, addonConfig?): Promise<string[]>

• Send a command and collect the output

  Parameters

  • command: string

    The R command to execute (similar to sendCommand)
  • OptionaladdonConfig: Partial<OutputCollectorConfiguration>

    Further configuration on how and what to collect: see OutputCollectorConfiguration, defaults are set in DEFAULT_OUTPUT_COLLECTOR_CONFIGURATION

  Returns Promise<string[]>

tryToInjectHomeLibPath

• tryToInjectHomeLibPath(): void

• Returns void

usedRVersion

• usedRVersion(): Promise<null | SemVer>

• Returns Promise<null | SemVer>