com.revo.deployr.client.params

Class ProjectExecutionOptions

java.lang.Object

com.revo.deployr.client.params.ProjectExecutionOptions

Direct Known Subclasses:

AnonymousProjectExecutionOptions, JobExecutionOptions

public class ProjectExecutionOptions
extends java.lang.Object

Project pre-and-post execution options.

Field Summary

Fields

Modifier and Type	Field and Description
ProjectAdoptionOptions	adoptionOptions Allows the pre-loading of a pre-existing project workspace, project working directory, project history and/or project package dependencies into the current R session prior to an execution.
boolean	artifactsoff When enabled all named files generated by an R execution into the working directory will not be cached in the server database nor appear in response markup.
boolean	consoleoff When enabled all R console output is suppressed and will not appear in response markup.
java.lang.String	csvrinputs Comma-seperated list of primitive R object names and values, to be added to the workspace of the current R session prior to the execution.
boolean	echooff When enabled R commands are not echoed to the console output and will not appear in response markup or on the event stream.
boolean	enableConsoleEvents When enabled R console output events corresponding to the current execution will be sent on the event stream.
boolean	encodeDataFramePrimitiveAsVector Workspace data.frame object encoding preference when retrieving R objects from the current R session following an execution.
java.lang.String	graphicsDevice Set R graphics device to use on execution: "png" or "svg".
int	graphicsHeight Set the height of the R graphics device on execution.
int	graphicsWidth Set the width of the R graphics device on execution.
java.lang.String	infinity Optional custom value to denote INFINITY values in DeployR-encoded objects in the response markup.
java.lang.String	nan Optional custom value to denote NAN values in DeployR-encoded objects in the response markup.
boolean	phantom When enabled meta-data about the execution is not recorded in the DeployR database and the execution does not appear in the RProject execution history.
java.lang.String	preloadByDirectory Allows the loading of all files found in one or more repository-managed directories into the working directory of the current R sesssion prior to execution.
ProjectPreloadOptions	preloadDirectory Allows the loading of one or more named files from the repository into the working directory of the current R session prior to execution.
ProjectPreloadOptions	preloadWorkspace Allows the loading of one or more named binary R objects from the repository into the workspace of the current R session prior to execution.
java.util.List<RData>	rinputs List of DeployR-encoded R objects to be added to the workspace of the current R session prior to the execution.
java.util.List<java.lang.String>	routputs List of workspace objects to be retrieved from the workspace of the current R session following the execution and returned as DeployR-encoded R objects.
ProjectStorageOptions	storageOptions Repository storage options allow the storage of one-or-more workspace objects, the entire workspace and/or one-or-more working directory files from the current R session into the repository following the execution.
java.lang.String	tag Optional tag to be associated with the execution that can be used later when viewing the execution history.

Constructor Summary

Constructors

Constructor and Description
ProjectExecutionOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

rinputs

public java.util.List<RData> rinputs

List of DeployR-encoded R objects to be added to the workspace of the current R session prior to the execution. Pre-execution option.

csvrinputs

public java.lang.String csvrinputs

Comma-seperated list of primitive R object names and values, to be added to the workspace of the current R session prior to the execution. eg. csvrinputs=name,George,age,45 Pre-execution option.

preloadWorkspace

public ProjectPreloadOptions preloadWorkspace

Allows the loading of one or more named binary R objects from the repository into the workspace of the current R session prior to execution. Pre-execution option.

preloadDirectory

public ProjectPreloadOptions preloadDirectory

Allows the loading of one or more named files from the repository into the working directory of the current R session prior to execution. Pre-execution option.

preloadByDirectory

public java.lang.String preloadByDirectory

Allows the loading of all files found in one or more repository-managed directories into the working directory of the current R sesssion prior to execution. When loading the contents of more than one directory, use a comma-separated list of directory names. Pre-execution option.

adoptionOptions

public ProjectAdoptionOptions adoptionOptions

Allows the pre-loading of a pre-existing project workspace, project working directory, project history and/or project package dependencies into the current R session prior to an execution. Pre-execution option.

graphicsDevice

public java.lang.String graphicsDevice

Set R graphics device to use on execution: "png" or "svg". The default R graphics device is "png". On-execution option.

graphicsWidth

public int graphicsWidth

Set the width of the R graphics device on execution. On-execution option.

graphicsHeight

public int graphicsHeight

Set the height of the R graphics device on execution. On-execution option.

enableConsoleEvents

public boolean enableConsoleEvents

When enabled R console output events corresponding to the current execution will be sent on the event stream. On-execution option.

echooff

public boolean echooff

When enabled R commands are not echoed to the console output and will not appear in response markup or on the event stream. On-execution option.

consoleoff

public boolean consoleoff

When enabled all R console output is suppressed and will not appear in response markup. This control has no impact on console output on the event stream. On-execution option.

artifactsoff

public boolean artifactsoff

When enabled all named files generated by an R execution into the working directory will not be cached in the server database nor appear in response markup. On-execution option.

routputs

public java.util.List<java.lang.String> routputs

List of workspace objects to be retrieved from the workspace of the current R session following the execution and returned as DeployR-encoded R objects. Post-execution option.

encodeDataFramePrimitiveAsVector

public boolean encodeDataFramePrimitiveAsVector

Workspace data.frame object encoding preference when retrieving R objects from the current R session following an execution. This option works in conjunction with the robjects property on this class. The default DeployR-encoding is to encode primatives inside data.frame objects as primitives, not as vectors. Post-execution option.

nan

public java.lang.String nan

Optional custom value to denote NAN values in DeployR-encoded objects in the response markup. Default is null. Post-execution option.

infinity

public java.lang.String infinity

Optional custom value to denote INFINITY values in DeployR-encoded objects in the response markup. Default is 0x7ff0000000000000L. Post-execution option.

storageOptions

public ProjectStorageOptions storageOptions

Repository storage options allow the storage of one-or-more workspace objects, the entire workspace and/or one-or-more working directory files from the current R session into the repository following the execution. Storage options are only available to AUTHENTICATED users on the call, ANONYMOUS users can not store data to the repository. Post-execution option.

tag

public java.lang.String tag

Optional tag to be associated with the execution that can be used later when viewing the execution history. Post-execution option.

phantom

public boolean phantom

When enabled meta-data about the execution is not recorded in the DeployR database and the execution does not appear in the RProject execution history.

Constructor Detail

ProjectExecutionOptions

public ProjectExecutionOptions()