uk.ac.liv.pgb.analytica.lib.wrappedr

Class RRuntime

java.lang.Object

uk.ac.liv.pgb.analytica.lib.wrappedr.RRuntime

All Implemented Interfaces:

org.rosuda.JRI.RMainLoopCallbacks

public final class RRuntime
extends Object
implements org.rosuda.JRI.RMainLoopCallbacks

Manages the interaction with the R runtime itself.

Author:

sperkins

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RRuntime.RRuntimeState The possible states of the runtime.

Method Summary

Modifier and Type	Method and Description
void	closeGraphicsDevice() Closes the graphics device, whatever it was.
void	execute(String command) Execute naked R code.
void	executeFunction(String function, String... arguments) Executes the given function by name, with the specified arguments.
static RRuntime	getInstance() Gets the singleton instance of this class.
RRuntime.RRuntimeState	getState() Gets the current state of this runtime.
boolean	isAvailable() Checks whether the R engine is available for use.
void	loadFileGraphicsDevice(File outputFile) Loads the file graphics device, as a PNG in the specified file.
void	loadJavaGraphicsDevice() Loads the java graphics device.
void	loadPackageDependency(String dependency) Install and load a package.
void	rBusy(org.rosuda.JRI.Rengine engine, int stateEvent) Indicate that the engine has changed its busy state.
String	rChooseFile(org.rosuda.JRI.Rengine engine, int newFile) Choose file for use in console.
void	rFlushConsole(org.rosuda.JRI.Rengine engine) Flush any buffered output.
void	rLoadHistory(org.rosuda.JRI.Rengine engine, String historyFile) Load the history from file.
String	rReadConsole(org.rosuda.JRI.Rengine engine, String consolePrompt, int addToHistory) Read text into the console.
void	rSaveHistory(org.rosuda.JRI.Rengine engine, String historyFile) Save the history to file.
void	rShowMessage(org.rosuda.JRI.Rengine engine, String errorWarning) Show warning/error text.
void	rWriteConsole(org.rosuda.JRI.Rengine engine, String outText, int outputType) Write text to the console.
void	source(File sourceFile) Reads and evaluates an R source file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static RRuntime getInstance()

Gets the singleton instance of this class. This method is synchronized as it may involve creation of a static object. Synchronization may be overkill here.

Returns:

Singleton instance of RRuntime.

isAvailable

public boolean isAvailable()

Checks whether the R engine is available for use.

Returns:

True if available for use.

getState

public RRuntime.RRuntimeState getState()

Gets the current state of this runtime.

Returns:

The current runtime state.

loadPackageDependency

public void loadPackageDependency(String dependency)

Install and load a package.

Parameters:

dependency - The name of the package to be installed/loaded.

loadFileGraphicsDevice

public void loadFileGraphicsDevice(File outputFile)

Loads the file graphics device, as a PNG in the specified file.

Parameters:

outputFile - The file to write the PNG data to.

loadJavaGraphicsDevice

public void loadJavaGraphicsDevice()

Loads the java graphics device.

closeGraphicsDevice

public void closeGraphicsDevice()

Closes the graphics device, whatever it was.

executeFunction

public void executeFunction(String function,
                            String... arguments)

Executes the given function by name, with the specified arguments.

Parameters:

function - The name of the function to be executed.

arguments - The arguments to the function to be executed.

source

public void source(File sourceFile)

Reads and evaluates an R source file.

Parameters:

sourceFile - The R source file.

execute

public void execute(String command)

Execute naked R code.

Parameters:

command - The R code to be executed.

rWriteConsole

public void rWriteConsole(org.rosuda.JRI.Rengine engine,
                          String outText,
                          int outputType)

Write text to the console.

Specified by:

rWriteConsole in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

outText - The text to write out.

outputType - Type of output. 0=Regular, 1=Error/Warning.

rBusy

public void rBusy(org.rosuda.JRI.Rengine engine,
                  int stateEvent)

Indicate that the engine has changed its busy state.

Specified by:

rBusy in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

stateEvent - The type of event being indicated. 1=Busy, 0=NotBusy

rReadConsole

public String rReadConsole(org.rosuda.JRI.Rengine engine,
                           String consolePrompt,
                           int addToHistory)

Read text into the console.

Specified by:

rReadConsole in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

consolePrompt - The console prompt text.

addToHistory - Whether to add the returned output to the history. 0=No, !0=Yes

Returns:

Text to be read in to the console.

rShowMessage

public void rShowMessage(org.rosuda.JRI.Rengine engine,
                         String errorWarning)

Show warning/error text.

Specified by:

rShowMessage in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

errorWarning - The error/warning text.

rChooseFile

public String rChooseFile(org.rosuda.JRI.Rengine engine,
                          int newFile)

Choose file for use in console.

Specified by:

rChooseFile in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

newFile - Whether a new or existing file is needed.

Returns:

The path of the chosen file.

rFlushConsole

public void rFlushConsole(org.rosuda.JRI.Rengine engine)

Flush any buffered output.

Specified by:

rFlushConsole in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

rSaveHistory

public void rSaveHistory(org.rosuda.JRI.Rengine engine,
                         String historyFile)

Save the history to file.

Specified by:

rSaveHistory in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

historyFile - The path of the history file to save.

rLoadHistory

public void rLoadHistory(org.rosuda.JRI.Rengine engine,
                         String historyFile)

Load the history from file.

Specified by:

rLoadHistory in interface org.rosuda.JRI.RMainLoopCallbacks

Parameters:

engine - The R engine.

historyFile - The path of the history file to load.