Package org.math.R

Class RenjinSession

java.lang.Object

org.math.R.Rsession

org.math.R.RenjinSession

All Implemented Interfaces:

RLog

public class RenjinSession
extends Rsession
implements RLog

Author:

richet

Nested Class Summary

Nested classes/interfaces inherited from class org.math.R.Rsession

Rsession.Function, Rsession.RException

Nested classes/interfaces inherited from interface org.math.R.RLog

RLog.Level

Field Summary

Fields

Modifier and Type	Field	Description
protected org.renjin.script.RenjinScriptEngine	R

Fields inherited from class org.math.R.Rsession

_PACKAGE_, CAST_ERROR, debug, DEFAULT_REPOS, envName, GRAPHIC_BMP, GRAPHIC_JPEG, GRAPHIC_PNG, GRAPHIC_TIFF, HEAD_SET, HEAD_TRY, PACKAGEINSTALLED, PACKAGELOADED, repos, SAVE_ASCII, TRY_MODE, TRY_MODE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
RenjinSession(PrintStream p, Properties properties)
RenjinSession(RLog console, Properties properties)

Method Summary

Modifier and Type	Method	Description
double[]	asArray(Object o)
double	asDouble(Object o)
int	asInteger(Object o)
int[]	asIntegers(Object o)
Map	asList(Object o)
boolean	asLogical(Object o)
boolean[]	asLogicals(Object o)
double[][]	asMatrix(Object o)
String	asString(Object o)
String[]	asStrings(Object o)
Object	cast(Object o)
void	closeLog()
void	copyGlobalEnv(String envName)
void	getFileFromWorkspace(File file)
String	gethomedir()
String	getwd()
String	installPackage(String pack, boolean load)	Start installation procedure of CRAN R package
String	installPackage(String pack, File dir, boolean load)	Start installation procedure of local R package
boolean	isAvailable()
boolean	isNull(Object o)
static void	main(String[] args)
static RenjinSession	newInstance(RLog console, Properties properties)
String	print(String command)	Get R command text output
File	putFileInWorkspace(File file)
boolean	set(String varname, double[][] data, String... names)	Set R data.frame in R env.
boolean	set(String varname, Object var)	Set R object in R env.
void	setCRANRepository(String url)
void	setGlobalEnv(String envName)
Object	silentlyRawEval(String expression, boolean tryEval)	Silently (ie no log) launch R command and return value.
boolean	silentlyVoidEval(String expression, boolean tryEval)	Silently (ie no log) launch R command without return value.
String	toString(Object o)

Methods inherited from class org.math.R.Rsession

addBusyListener, addEvalListener, addLogger, addUpdateObjectsListener, asHTML, asR2HTML, buildList, buildListPattern, buildListString, cat, cat, cat, cat, cat, cat, cat, end, eval, eval, finalize, getGlobalEnv, getLastError, getLastLogEntry, getLastOutput, getRepository, hash, installPackage, installPackages, isPackageInstalled, isPackageLoaded, listCommands, load, loadPackage, local2remotePath, log, ls, ls, ls, note_code, note_code, note_header, note_text, notebook, proxyEval, rawEval, rawEval, remote2localPath, removeBusyListener, removeEvalListener, removeLogger, removeUpdateObjectsListener, reshapeAsRow, reshapeAsRow, rm, rmAll, rmAll, rmls, save, savels, set, setBusy, setRepository, setwd, silentlyRawEval, silentlyVoidEval, sinkMessage, sinkOutput, source, t, toBMP, toGraphic, toGraphic, toHTML, toJPEG, toPNG, toRcode, toRcode, toRcode, toRcode, toRcode, toRcode, toRcode, toRpath, toRpath, toTIFF, typeOf, unset, unset, voidEval, voidEval

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.math.R.RLog

log

Field Detail

R

protected org.renjin.script.RenjinScriptEngine R

Constructor Detail

RenjinSession

public RenjinSession(RLog console,
                     Properties properties)

RenjinSession

public RenjinSession(PrintStream p,
                     Properties properties)

Method Detail

newInstance

public static RenjinSession newInstance(RLog console,
                                        Properties properties)

gethomedir

public String gethomedir()

Specified by:

gethomedir in class Rsession

silentlyVoidEval

public boolean silentlyVoidEval(String expression,
                                boolean tryEval)

Description copied from class: Rsession

Silently (ie no log) launch R command without return value.

Specified by:

silentlyVoidEval in class Rsession

Parameters:

expression - R expresison to evaluate

tryEval - encapsulate command in try() to cacth errors

Returns:

well evaluated ?

silentlyRawEval

public Object silentlyRawEval(String expression,
                              boolean tryEval)

Description copied from class: Rsession

Silently (ie no log) launch R command and return value.

Specified by:

silentlyRawEval in class Rsession

Parameters:

expression - R expression to evaluate

tryEval - encapsulate command in try() to cacth errors

Returns:

REXP R expression

set

public boolean set(String varname,
                   double[][] data,
                   String... names)

Description copied from class: Rsession

Set R data.frame in R env.

Specified by:

set in class Rsession

Parameters:

varname - R list name

data - numeric data in list

names - names of columns

Returns:

succeeded ?

set

public boolean set(String varname,
                   Object var)

Description copied from class: Rsession

Set R object in R env.

Specified by:

set in class Rsession

Parameters:

varname - R object name

var - R object value

Returns:

succeeded ?

asDouble

public double asDouble(Object o)
                throws ClassCastException

Specified by:

asDouble in class Rsession

Throws:

ClassCastException

asArray

public double[] asArray(Object o)
                 throws ClassCastException

Specified by:

asArray in class Rsession

Throws:

ClassCastException

asMatrix

public double[][] asMatrix(Object o)
                    throws ClassCastException

Specified by:

asMatrix in class Rsession

Throws:

ClassCastException

asString

public String asString(Object o)
                throws ClassCastException

Specified by:

asString in class Rsession

Throws:

ClassCastException

asStrings

public String[] asStrings(Object o)
                   throws ClassCastException

Specified by:

asStrings in class Rsession

Throws:

ClassCastException

asInteger

public int asInteger(Object o)
              throws ClassCastException

Specified by:

asInteger in class Rsession

Throws:

ClassCastException

asIntegers

public int[] asIntegers(Object o)
                 throws ClassCastException

Specified by:

asIntegers in class Rsession

Throws:

ClassCastException

asLogical

public boolean asLogical(Object o)
                  throws ClassCastException

Specified by:

asLogical in class Rsession

Throws:

ClassCastException

asLogicals

public boolean[] asLogicals(Object o)
                     throws ClassCastException

Specified by:

asLogicals in class Rsession

Throws:

ClassCastException

asList

public Map asList(Object o)
           throws ClassCastException

Specified by:

asList in class Rsession

Throws:

ClassCastException

isNull

public boolean isNull(Object o)

Specified by:

isNull in class Rsession

toString

public String toString(Object o)

Specified by:

toString in class Rsession

closeLog

public void closeLog()

Specified by:

closeLog in interface RLog

Overrides:

closeLog in class Rsession

cast

public Object cast(Object o)
            throws ClassCastException

Specified by:

cast in class Rsession

Throws:

ClassCastException

print

public String print(String command)

Get R command text output

Overrides:

print in class Rsession

Parameters:

command - R command returning text

Returns:

String

setCRANRepository

public void setCRANRepository(String url)

Overrides:

setCRANRepository in class Rsession

Parameters:

url - CRAN repository to use for packages installation (eg http://cran.r-project.org)

installPackage

public String installPackage(String pack,
                             boolean load)

Description copied from class: Rsession

Start installation procedure of CRAN R package

Overrides:

installPackage in class Rsession

Parameters:

pack - package to install

load - automatically load package after successfull installation

Returns:

installation status

installPackage

public String installPackage(String pack,
                             File dir,
                             boolean load)

Description copied from class: Rsession

Start installation procedure of local R package

Overrides:

installPackage in class Rsession

Parameters:

pack - package to install

dir - directory where package file (.zip, .tar.gz or .tgz) is located.

load - automatically load package after successfull installation

Returns:

installation status

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in class Rsession

getwd

public String getwd()

Overrides:

getwd in class Rsession

putFileInWorkspace

public File putFileInWorkspace(File file)

Specified by:

putFileInWorkspace in class Rsession

getFileFromWorkspace

public void getFileFromWorkspace(File file)

Specified by:

getFileFromWorkspace in class Rsession

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

setGlobalEnv

public void setGlobalEnv(String envName)

Specified by:

setGlobalEnv in class Rsession

copyGlobalEnv

public void copyGlobalEnv(String envName)

Specified by:

copyGlobalEnv in class Rsession