com.jstatcom.engine.rstat
Class RArgProps

java.lang.Object
  com.jstatcom.model.JSCPropertyTypes
      com.jstatcom.engine.rstat.RArgProps

public final class RArgProps
extends JSCPropertyTypes

Typesave enum that defines property types for JSCData objects that can be used to adjust how JSCData objects are used by R. The defined property types can be used in the setJSCProperty, getJSCProperty methods of JSCData.

Author:

Markus Kraetzig

Field Summary

static RArgProps	AS_EXPR Legal values are boolean values true and false.
static RArgProps	AS_FORMULA Legal values are boolean values true and false.
static RArgProps	DFRAME_VARNAMES Legal values are String[] arrays where the entries are valid R symbols.
static RArgProps	PARAM_NAME Legal values are valid variable names.
static RArgProps	RLIST_KEY Legal values are valid variable names.

Method Summary

Methods inherited from class com.jstatcom.model.JSCPropertyTypes

equals, hashCode, name, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAM_NAME

public static final RArgProps PARAM_NAME

Legal values are valid variable names.

If this property is set, then the underlying object will be used with the parameter name that has been set in R procedure calls.

If the property was set to be "from" and "to" in two input arguments, then the R procedure seq is called as: seq(from = 1, to = 1). If this property was not set, then only the ordering of the input variables is used to match the corresponding parameters. For some R functions this can be problematic, e.g. par.

AS_FORMULA

public static final RArgProps AS_FORMULA

Legal values are boolean values true and false.

Special convenience property that is only used for JSCString variables. If this is set to true then the underlying string is converted to an R formula via the R call as.formula(s). This is convenient, for example, when the R procedure lm should be called with a model expression that has been set in Java.

AS_EXPR

public static final RArgProps AS_EXPR

Legal values are boolean values true and false.

Special convenience property that is only used for JSCString variables. If this is set to true then the underlying string is converted to an R expression via the R call parse(test=s). This is convenient, for example, when special mathematical annotations should be used, e.g. expression(theta).

RLIST_KEY

public static final RArgProps RLIST_KEY

Legal values are valid variable names.

This property is only employed for JSCData objects that are used as return parameters for R function calls when the returned R object is an R list. The property values are then interpreted as the keys of the returned list. If the returned R object is just a scalar then this property is ignored. If this property is not set and a list is returned then the JSCData name is used as the list key.

DFRAME_VARNAMES

public static final RArgProps DFRAME_VARNAMES

Legal values are String[] arrays where the entries are valid R symbols. The lengths of the string array must equal the number of columns in the underlying JSCNArray.

This property is only used for JSCNArray objects. If it is non null and the data object is used as an input argument in the RStatEngine.call method, it will be converted into an R data.frame with the property value string array defining the variables names corresponding to columns in the data frame.

This property can be used to call the R lm method directly with a data.frame argument. The variables names set in the property value string array can then be used in the corresponding model definition, see also AS_FORMULA property.