io.onetapbeyond.renjin.r.executor

Class Renjin

java.lang.Object

io.onetapbeyond.renjin.r.executor.Renjin

public class Renjin
extends java.lang.Object

Builder of executable R tasks targeting the Renjin interpreter for scientific computing, reproducible research and data analysis based on R. To create an instance of a RenjinTask capable of executing any function or script within Renjin-compatible R packages, use the following builder pattern:

 
 
 RenjinTask rTask = Renjin.R().code(rCode).input(rInput).build();
 
 

The executable R code for the task is specified using the code(...) methods. One or more data inputs are passed on an executable R task using the input(...) methods. If your application runs in a single JVM environment you can use the Renjin.R(boolean, boolean) method to optionally bypass RenjinTask and RenjinResult serialization.

Method Summary

Modifier and Type	Method and Description
RenjinTask	build() Create an instance of an executable R task.
RenjinTask	build(javax.script.ScriptEngine suppliedEngine) Create an instance of an executable R task.
RenjinTask	build(javax.script.ScriptEngine suppliedEngine, boolean autoClearSuppliedEngine) Create an instance of an executable R task.
Renjin	code(java.io.Reader code) Specify the R code for the executable R task.
Renjin	code(java.lang.String code) Specify the R code for the executable R task.
Renjin	input(java.util.Map<java.lang.String,java.lang.Object> nameValues) Specify data inputs for the executable R task.
Renjin	input(java.lang.String name, java.lang.Object value) Specify a data input for the executable R task.
static Renjin	R() Create an instance of a Renjin task builder.
static Renjin	R(boolean disableTaskSerialization, boolean disableResultSerialization) Create an instance of a Renjin task builder.
static javax.script.ScriptEngine	scriptEngine() Renjin ScriptEngine factory.

Methods inherited from class java.lang.Object

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

Method Detail

R

public static Renjin R()

Create an instance of a Renjin task builder.

Returns:

an instance of a Renjin task builder

R

public static Renjin R(boolean disableTaskSerialization,
                       boolean disableResultSerialization)

Create an instance of a Renjin task builder. By default, both RenjinTask and RenjinResult are serialized. If either your RenjinTask or RenjinResult do not require serialization, for example, when executing within a single JVM environment, then enable the disableTaskSerialization and disableResultSerialization parameters respectively.

Parameters:

disableTaskSerialization - disable RenjinTask serialization

disableResultSerialization - disable RenjinResult serialization

Returns:

the current Renjin task builder instance

code

public Renjin code(java.lang.String code)
            throws RenjinException

Specify the R code for the executable R task.

Parameters:

code - the R code to execute on the RenjinTask

Returns:

the current Renjin task builder instance

Throws:

RenjinException - if R code provided is null

code

public Renjin code(java.io.Reader code)
            throws RenjinException

Specify the R code for the executable R task.

Parameters:

code - the R code to execute on the RenjinTask

Returns:

the current Renjin task builder instance

Throws:

RenjinException - if Reader provided could not be read

input

public Renjin input(java.lang.String name,
                    java.lang.Object value)
             throws RenjinException

Specify a data input for the executable R task.

Parameters:

name - data input name

value - data input value

Returns:

the current Renjin task builder instance

Throws:

RenjinException - if input data could not be serialized

input

public Renjin input(java.util.Map<java.lang.String,java.lang.Object> nameValues)
             throws RenjinException

Specify data inputs for the executable R task.

Parameters:

nameValues - a Map of data input name-value pairs.

Returns:

the current Renjin task builder instance

Throws:

RenjinException - if input data could not be serialized

build

public RenjinTask build()
                 throws RenjinException

Create an instance of an executable R task.

Returns:

an instance of a new executable RenjinTask

Throws:

RenjinException - if executable R task definition is incomplete

build

public RenjinTask build(javax.script.ScriptEngine suppliedEngine)
                 throws RenjinException

Create an instance of an executable R task.

Parameters:

suppliedEngine - a ScriptEngine supplied by the calling application to use when executing the task

Returns:

an instance of a new executable RenjinTask

Throws:

RenjinException - if RenjinTask definition is incomplete

build

public RenjinTask build(javax.script.ScriptEngine suppliedEngine,
                        boolean autoClearSuppliedEngine)
                 throws RenjinException

Create an instance of an executable R task.

Parameters:

suppliedEngine - a ScriptEngine supplied by the calling application to use when executing the task ScriptEngine on which to execute the R task

autoClearSuppliedEngine - enable if the suppliedEngine bindings and workspace should be cleared following R task execution

Returns:

an instance of a new executable RenjinTask

Throws:

RenjinException - if RenjinTask definition is incomplete

scriptEngine

public static javax.script.ScriptEngine scriptEngine()

Renjin ScriptEngine factory. Provided as a convenience method where external control over the Renjin runtime environment is required. Intended to be used in conjunction with the build(ScriptEngine) and the build(ScriptEngine, boolean) methods.

Returns:

an instance of a Renjin ScriptEngine