io.onetapbeyond.opencpu.r.executor

Class OCPU

java.lang.Object

io.onetapbeyond.opencpu.r.executor.OCPU

public class OCPU
extends java.lang.Object

Builder of executable R tasks targeting the OpenCPU server for scientific computing, reproducible research and data analysis based on R. To create an instance of an OCPUTask capable of executing any function or script within CRAN, Bioconductor or Github R packages, use the following builder pattern:

 
 
 OCPUTask oTask = OCPU.R().pkg(pName).function(fName).input(fInput).library();
 
 

Method Summary

Modifier and Type	Method and Description
OCPUTask	bioc() Build an OCPUTask using an R package on Bioconductor.
OCPUTask	cran() Build an OCPUTask using an R package on CRAN.
OCPU	function(java.lang.String function) Specify R function name on the OCPUTask.
OCPUTask	gist() Build an OCPUTask using an R package on Gist.
OCPUTask	github() Build an OCPUTask using an R package on GitHub.
OCPU	input(java.util.Map input) Specify input data on the OCPUTask.
OCPUTask	library() Build an OCPUTask using an R package on the OpenCPU server.
OCPU	pkg(java.lang.String pkg) Specify R package name on the OCPUTask.
static OCPU	R() Initialize OCPUTask builder instance.
OCPU	script(java.lang.String script, java.lang.String output) Specify R script name on the OCPUTask.
OCPU	user(java.lang.String user) Specify user on the OCPUTask.

Methods inherited from class java.lang.Object

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

Method Detail

R

public static OCPU R()

Initialize OCPUTask builder instance.

Returns:

initialized OCPUTask builder instance.

user

public OCPU user(java.lang.String user)

Specify user on the OCPUTask. Users are optional. When specified, the user indicates the private library, github, gist R package owner of the function or script being executed by the task.

Parameters:

user - the user on the OCPUTask.

Returns:

OCPUTask builder instance.

pkg

public OCPU pkg(java.lang.String pkg)

Specify R package name on the OCPUTask.

Parameters:

pkg - the package on the OCPUTask.

Returns:

OCPUTask builder instance.

function

public OCPU function(java.lang.String function)

Specify R function name on the OCPUTask.

Parameters:

function - the function on the OCPUTask.

Returns:

OCPUTask builder instance.

script

public OCPU script(java.lang.String script,
                   java.lang.String output)

Specify R script name on the OCPUTask.

Parameters:

script - the script on the OCPUTask.

output - named R object to be returned on the OCPUTask.

Returns:

OCPUTask builder instance.

input

public OCPU input(java.util.Map input)
           throws OCPUException

Specify input data on the OCPUTask.

Parameters:

input - a Map representing the JSON data input

Returns:

OCPUTask builder instance

Throws:

OCPUException - if input can not be converted to valid JSON

library

public OCPUTask library()

Build an OCPUTask using an R package on the OpenCPU server.

Returns:

an executable OCPUTask.

cran

public OCPUTask cran()

Build an OCPUTask using an R package on CRAN.

Returns:

an executable OCPUTask.

bioc

public OCPUTask bioc()

Build an OCPUTask using an R package on Bioconductor.

Returns:

an executable OCPUTask.

github

public OCPUTask github()

Build an OCPUTask using an R package on GitHub.

Returns:

an executable OCPUTask.

gist

public OCPUTask gist()

Build an OCPUTask using an R package on Gist.

Returns:

an executable OCPUTask.