com.sas.cas.actions.dataPreprocess

Class EvaluationStatsOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.dataPreprocess.EvaluationStatsOptions

All Implemented Interfaces:

KeyedMap<java.lang.String,java.lang.Object>, java.io.Serializable, java.util.Map<java.lang.String,java.lang.Object>

public class EvaluationStatsOptions
extends CASGeneratedActionOptions

Options for transform: Performs pipelined variable imputation, outlier detection and treatment, functional transformation, binning, and robust univariate statistics to evaluate the quality of the transformation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.cas.CASActionOptions

CASActionOptions.EnumValue, CASActionOptions.FORMAT

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ALL
static java.lang.String	KEY_CHISQGROUP
static java.lang.String	KEY_CORRELATIONGROUP
static java.lang.String	KEY_DEFAULT
static java.lang.String	KEY_ENTROPYGROUP
static java.lang.String	KEY_FTTESTGROUP
static java.lang.String	KEY_NBINSINPUT
static java.lang.String	KEY_NBINSTARGET
static java.lang.String	KEY_UNIVARIATEGROUP
static java.lang.String	KEY_WOEGROUP

Fields inherited from class com.sas.cas.CASActionOptions

FLAGS_EXPAND_ARRAYS, FLAGS_IGNORE_DISPOSITION_ERROR, FLAGS_RETURN_RESULTS_ON_EXCEPTION, FLAGS_SKIP_ACTION_EVENTS, FLAGS_SKIP_RESULTS, HIDDEN_PASSWORD, JSON_NULL, LUA_NIL, PARAMETER_FLAG_ISPASSWORD, PARAMETER_FLAG_ISPATH, PARAMETER_FLAG_ISTABLENAME, PARAMETER_FLAG_ISVAR, PARAMETER_FLAG_REQUIRED, PYTHON_NULL, SERIALIZED_PREFIX

Constructor Summary

Constructors

Constructor and Description
EvaluationStatsOptions()
EvaluationStatsOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAll()
java.lang.Boolean	getChiSqGroup()
java.lang.Boolean	getCorrelationGroup()
java.lang.Boolean	getDefault()
java.lang.Boolean	getEntropyGroup()
java.lang.Boolean	getFtTestGroup()
java.lang.Integer	getNBinsEval()
java.lang.Integer	getNBinsInput()
java.lang.Integer	getNBinsTarget()
java.lang.Integer	getNBinsTrans()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Boolean	getUnivariateGroup()
java.lang.Boolean	getWoeGroup()
EvaluationStatsOptions	setAll(java.lang.Boolean value) Sets the value of parameter 'all': when set to True, all applicable transformation evaluation statistics are computed.
EvaluationStatsOptions	setChiSqGroup(java.lang.Boolean value) Sets the value of parameter 'chiSqGroup': when set to True, the Chi-Square and G2 statistics are computed.
EvaluationStatsOptions	setCorrelationGroup(java.lang.Boolean value) Sets the value of parameter 'correlationGroup': when set to True, Pearson, maximal and distance correlation estimates are computed.
EvaluationStatsOptions	setDefault(java.lang.Boolean value) Sets the value of parameter 'default': when set to True, the default transformation evaluation statistics are computed.
EvaluationStatsOptions	setEntropyGroup(java.lang.Boolean value) Sets the value of parameter 'entropyGroup': when set to True, mutual information, information gain, symmetric uncertainty, and entropy statistics are computed.
EvaluationStatsOptions	setFtTestGroup(java.lang.Boolean value) Sets the value of parameter 'ftTestGroup': when set to True, F-test and Welch's T-test statistics are computed.
EvaluationStatsOptions	setNBinsEval(java.lang.Integer value)
EvaluationStatsOptions	setNBinsInput(java.lang.Integer value) Sets the value of parameter 'nBinsInput': specifies the number of bins to use for interval transformed input variables.
EvaluationStatsOptions	setNBinsTarget(java.lang.Integer value) Sets the value of parameter 'nBinsTarget': specifies the number of bins to use for the interval target variables.
EvaluationStatsOptions	setNBinsTrans(java.lang.Integer value)
EvaluationStatsOptions	setUnivariateGroup(java.lang.Boolean value) Sets the value of parameter 'univariateGroup': when set to True, robust scale, skewness and kurtosis measures are computed.
EvaluationStatsOptions	setWoeGroup(java.lang.Boolean value) Sets the value of parameter 'woeGroup': when set to True, the WOE, IV and Gini index statistics are computed.

Methods inherited from class com.sas.cas.CASActionOptions

addActionFlags, addParameterFlag, appendValue, checkForPasswords, clear, containsKey, containsValue, convertToEnumArray, copy, deserialize, entrySet, equals, findOptionsClass, findSetter, get, getActionFlags, getActionName, getActionResponseEventListener, getActionResultEventListener, getActionSetName, getCASClient, getClassName, getDebugOptions, getDispositionEventListener, getFullyQualifiedActionName, getLogEventListener, getLogMessage, getMessageOutputStream, getMessageTagHandler, getParameter, getParameterAsBoolean, getParameterAsByteArray, getParameterAsDouble, getParameterAsDoubleArray, getParameterAsInteger, getParameterAsIntegerArray, getParameterAsLong, getParameterAsLongArray, getParameterAsString, getParameterAsStringArray, getParameterFlags, getParameterIgnoreCase, getParameterIgnoreCase, getParameterKeys, getPerformanceEventListener, getPropertyKey, getSessionID, getUserProperty, getUserPropertyKeys, hashCode, invoke, isEmpty, isFlagSet, isMap, isParameterFlagSet, isPassword, isPath, isRequired, isTable, isVariable, keySet, put, putAll, putAllDeep, putDeep, putDeep, quoteIfNotNull, remove, removeParameter, set, setActionFlags, setActionName, setActionResponseEventListener, setActionResultEventListener, setActionSetName, setCASClient, setDebugOptions, setDispositionEventListener, setFullyQualifiedActionName, setLogEventListener, setLogMessage, setMessageOutputStream, setMessageTagHandler, setParameter, setPerformanceEventListener, setPropertyKey, setSessionID, setUserProperty, size, toCASLString, toLuaString, toLuaString, toOptionsWithGeneratedClasses, toSerialized, toString, toString, toString, upcaseFirstChar, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

KEY_WOEGROUP

public static final java.lang.String KEY_WOEGROUP

See Also:

Constant Field Values

KEY_CHISQGROUP

public static final java.lang.String KEY_CHISQGROUP

See Also:

Constant Field Values

KEY_FTTESTGROUP

public static final java.lang.String KEY_FTTESTGROUP

See Also:

Constant Field Values

KEY_ENTROPYGROUP

public static final java.lang.String KEY_ENTROPYGROUP

See Also:

Constant Field Values

KEY_CORRELATIONGROUP

public static final java.lang.String KEY_CORRELATIONGROUP

See Also:

Constant Field Values

KEY_UNIVARIATEGROUP

public static final java.lang.String KEY_UNIVARIATEGROUP

See Also:

Constant Field Values

KEY_DEFAULT

public static final java.lang.String KEY_DEFAULT

See Also:

Constant Field Values

KEY_ALL

public static final java.lang.String KEY_ALL

See Also:

Constant Field Values

KEY_NBINSINPUT

public static final java.lang.String KEY_NBINSINPUT

See Also:

Constant Field Values

KEY_NBINSTARGET

public static final java.lang.String KEY_NBINSTARGET

See Also:

Constant Field Values

Constructor Detail

EvaluationStatsOptions

public EvaluationStatsOptions()

EvaluationStatsOptions

public EvaluationStatsOptions(CASActionOptions options)

Method Detail

getServerDefaultValue

public java.lang.Object getServerDefaultValue(java.lang.String key)

Description copied from class: CASActionOptions

Gets the server default value, if known.

Overrides:

getServerDefaultValue in class CASActionOptions

Parameters:

key - The parameter key

Returns:

THe default value, or null if not known

getWoeGroup

public java.lang.Boolean getWoeGroup()

setWoeGroup

public EvaluationStatsOptions setWoeGroup(java.lang.Boolean value)

Sets the value of parameter 'woeGroup': when set to True, the WOE, IV and Gini index statistics are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getChiSqGroup

public java.lang.Boolean getChiSqGroup()

setChiSqGroup

public EvaluationStatsOptions setChiSqGroup(java.lang.Boolean value)

Sets the value of parameter 'chiSqGroup': when set to True, the Chi-Square and G2 statistics are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getFtTestGroup

public java.lang.Boolean getFtTestGroup()

setFtTestGroup

public EvaluationStatsOptions setFtTestGroup(java.lang.Boolean value)

Sets the value of parameter 'ftTestGroup': when set to True, F-test and Welch's T-test statistics are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getEntropyGroup

public java.lang.Boolean getEntropyGroup()

setEntropyGroup

public EvaluationStatsOptions setEntropyGroup(java.lang.Boolean value)

Sets the value of parameter 'entropyGroup': when set to True, mutual information, information gain, symmetric uncertainty, and entropy statistics are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getCorrelationGroup

public java.lang.Boolean getCorrelationGroup()

setCorrelationGroup

public EvaluationStatsOptions setCorrelationGroup(java.lang.Boolean value)

Sets the value of parameter 'correlationGroup': when set to True, Pearson, maximal and distance correlation estimates are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getUnivariateGroup

public java.lang.Boolean getUnivariateGroup()

setUnivariateGroup

public EvaluationStatsOptions setUnivariateGroup(java.lang.Boolean value)

Sets the value of parameter 'univariateGroup': when set to True, robust scale, skewness and kurtosis measures are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getDefault

public java.lang.Boolean getDefault()

setDefault

public EvaluationStatsOptions setDefault(java.lang.Boolean value)

Sets the value of parameter 'default': when set to True, the default transformation evaluation statistics are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getAll

public java.lang.Boolean getAll()

setAll

public EvaluationStatsOptions setAll(java.lang.Boolean value)

Sets the value of parameter 'all': when set to True, all applicable transformation evaluation statistics are computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getNBinsInput

public java.lang.Integer getNBinsInput()

getNBinsTrans

public java.lang.Integer getNBinsTrans()

setNBinsInput

public EvaluationStatsOptions setNBinsInput(java.lang.Integer value)

Sets the value of parameter 'nBinsInput': specifies the number of bins to use for interval transformed input variables. This is required by evaluation statistics such as distance correlation that need binning approximation.

Parameters:

value - The value

Returns:

The options object

setNBinsTrans

public EvaluationStatsOptions setNBinsTrans(java.lang.Integer value)

getNBinsTarget

public java.lang.Integer getNBinsTarget()

getNBinsEval

public java.lang.Integer getNBinsEval()

setNBinsTarget

public EvaluationStatsOptions setNBinsTarget(java.lang.Integer value)

Sets the value of parameter 'nBinsTarget': specifies the number of bins to use for the interval target variables. This is required by evaluation statistics such as distance correlation that need binning approximation.

Parameters:

value - The value

Returns:

The options object

setNBinsEval

public EvaluationStatsOptions setNBinsEval(java.lang.Integer value)