RcppOctave (version 0.11.3)

octave_start: Low-level Function Interfacing with Octave

Description

octave_start Initialize an Octave session.

octave_end clears and terminates the current Octave session.

octave_verbose toggles the verbosity of RcppOctave calls: messages tracks any function call, or conversion of objects between R and Octave (e.g. arguments and results).

octave_config uses the octave-config system utility that ships with Octave to query details about the local Octave installation. Failure to load Octave configuration is generally due to this Octave binary not being found in the system PATH. Users should ensure that the PATH contains Octave binary directory path. Alternatively one may use option 'octave.path' to specify the directory where to find octave-config:

octave_modules add the Octave modules that ship with RcppOctave to Octave loading path.

Usage

octave_start(verbose = FALSE, warnings = FALSE,
    force = FALSE)
  octave_end()
  octave_verbose(value)
  octave_config(varname, verbose = FALSE, warn = TRUE,
    mustWork = TRUE, bindir = getOption("octave.path"))
  octave_modules(verbose = getOption("verbose"))

Arguments

verbose

logical value used as the inital verbosity status.

warnings

logical that indicates if Octave startup warnings

force

logical that indicates if Octave session should be reinitialised, even if one was previously started (not meant to be used by end-users). should be shown.

value

logical value to toggle verbosity

varname

Name (as a character string) of the Octave configuration variable to retrieve. It is used in following system call octave-config -p . This function is vectorised and returns a character vector of the same length as its argume

warn

logical that indicates if a warning should be thrown when a variable is returned empty, which generally means that x is not a valid config variable name.

mustWork

logical that indicates if an error should be thrown if failing to load Octave configuration.

bindir

path to Octave bin/ sub-directory where to look for octave-config. If NULL or NA, then the system PATH is used.

Details

options(octave.path = '/absolute/path/to/octave/bin')

Note that in this case, the system PATH is not used.

See Also

OctaveConfig