com.sas.cas.actions.phreg

Class CoxOptions

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.phreg.CoxOptions

All Implemented Interfaces:

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

public class CoxOptions
extends CASGeneratedActionOptions

Options for cox: Fit Cox regression model.

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	ACTION_NAME
static java.lang.String	ACTION_SET_NAME
static java.lang.String	KEY_ALPHA
static java.lang.String	KEY_CLASS
static java.lang.String	KEY_CLASSGLOBALOPTS
static java.lang.String	KEY_CLASSLEVELSPRINT
static java.lang.String	KEY_CODE
static java.lang.String	KEY_COLLECTION
static java.lang.String	KEY_CORRB
static java.lang.String	KEY_COVB
static java.lang.String	KEY_DISPLAY
static java.lang.String	KEY_FREQ
static java.lang.String	KEY_LASSORHO
static java.lang.String	KEY_LASSOSTEPS
static java.lang.String	KEY_LASSOTOL
static java.lang.String	KEY_MODEL
static java.lang.String	KEY_MULTIMEMBER
static java.lang.String	KEY_NCLASSLEVELSPRINT
static java.lang.String	KEY_NOSTDERR
static java.lang.String	KEY_OPTIMIZATION
static java.lang.String	KEY_OUTPUT
static java.lang.String	KEY_OUTPUTTABLES
static java.lang.String	KEY_PARTBYFRAC
static java.lang.String	KEY_PARTBYVAR
static java.lang.String	KEY_POLYNOMIAL
static java.lang.String	KEY_SELECTION
static java.lang.String	KEY_SPLINE
static java.lang.String	KEY_STRATA
static java.lang.String	KEY_STRATAMISSING
static java.lang.String	KEY_TABLE
static java.lang.String	KEY_WEIGHT

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
CoxOptions()
CoxOptions(CASActionOptions options)

Method Summary

Modifier and Type	Method and Description
java.lang.Double	getAlpha()
Classopts	getClassglobalopts()
java.lang.Boolean	getClassLevelsPrint()
ClassStatement[]	getClassParameter()
ClassStatement[]	getClassVars()
Coxcodegen	getCode()
Collection[]	getCollection()
java.lang.Boolean	getCorrB()
java.lang.Boolean	getCovB()
DisplayTables	getDisplay()
java.lang.String	getFreq()
java.lang.Double	getLassoRho()
java.lang.Integer	getLassoSteps()
java.lang.Double	getLassoTol()
Coxmodel	getModel()
Multimember[]	getMultimember()
java.lang.Integer	getNClassLevelsPrint()
ClassStatement[]	getNominal()
java.lang.Boolean	getNostderr()
OptimizationStatement	getOptimization()
CoxOutputStatement	getOutput()
OutputTables	getOutputTables()
PartByFracStatement	getPartbyfrac()
PartByVarStatement	getPartbyvar()
Polynomial[]	getPoly()
Polynomial[]	getPolynomial()
SelectionStatement	getSelection()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
Spline[]	getSpline()
java.lang.String	getStrata()
java.lang.Boolean	getStratamissing()
Castable	getTable()
java.lang.String	getWeight()
CoxOptions	setAlpha(java.lang.Double value) Sets the value of parameter 'alpha': specifies the significance level used for the construction of all confidence intervals.
CoxOptions	setClassglobalopts(Classopts value) Sets the value of parameter 'classglobalopts': lists options that apply to all classification variables.
CoxOptions	setClassLevelsPrint(java.lang.Boolean value) Sets the value of parameter 'classLevelsPrint': suppresses the display of class levels.
CoxOptions	setClassParameter(ClassStatement[] value) Sets the value of parameter 'class': names the classification variables to be used as explanatory variables in the analysis.
CoxOptions	setClassVars(ClassStatement[] value)
CoxOptions	setCode(Coxcodegen value) Sets the value of parameter 'code': writes SAS DATA step code for computing predicted values of the fitted model.
CoxOptions	setCollection(Collection[] value) Sets the value of parameter 'collection': defines a set of variables that are treated as a single effect that has multiple degrees of freedom.
CoxOptions	setCorrB(java.lang.Boolean value) Sets the value of parameter 'corrB': when set to True, displays the correlation matrix of the parameters.
CoxOptions	setCovB(java.lang.Boolean value) Sets the value of parameter 'covB': when set to True, displays the covariance matrix of the parameters.
CoxOptions	setDisplay(DisplayTables value) Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.
CoxOptions	setFreq(java.lang.String value) Sets the value of parameter 'freq': names the numeric variable that contains the frequency of occurrence for each observation.
CoxOptions	setLassoRho(java.lang.Double value) Sets the value of parameter 'lassoRho': specifies the base regularization parameter for the LASSO method.
CoxOptions	setLassoSteps(java.lang.Integer value) Sets the value of parameter 'lassoSteps': specifies the maximum number of steps for the LASSO method.
CoxOptions	setLassoTol(java.lang.Double value) Sets the value of parameter 'lassoTol': specifies the convergence criterion for the LASSO method.
CoxOptions	setModel(Coxmodel value) Sets the value of parameter 'model': names the dependent variable, explanatory effects and model options.
CoxOptions	setMultimember(Multimember[] value) Sets the value of parameter 'multimember': uses one or more classification variables specified in the vars parameter in such a way that each observation can be associated with one or more levels of the union of the levels of the classification variables.
CoxOptions	setNClassLevelsPrint(java.lang.Integer value) Sets the value of parameter 'nClassLevelsPrint': limits the display of class levels.
CoxOptions	setNominal(ClassStatement[] value)
CoxOptions	setNostderr(java.lang.Boolean value) Sets the value of parameter 'nostderr': when set to True, the covariance matrix and any statistic that depends on it are not computed.
CoxOptions	setOptimization(OptimizationStatement value) Sets the value of parameter 'optimization': specifies the technique and options for performing the optimization.
CoxOptions	setOutput(CoxOutputStatement value) Sets the value of parameter 'output': creates a table on the server that contains observationwise statistics, which are computed after fitting the model.
CoxOptions	setOutputTables(OutputTables value) Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.
CoxOptions	setPartbyfrac(PartByFracStatement value) Sets the value of parameter 'partbyfrac': specifies the fractions of the data to be used for validation and testing.
CoxOptions	setPartbyvar(PartByVarStatement value) Sets the value of parameter 'partbyvar': names the variable and its values used to partition the data into training, validation and testing roles.
CoxOptions	setPoly(Polynomial[] value)
CoxOptions	setPolynomial(Polynomial[] value) Sets the value of parameter 'polynomial': specifies a polynomial effect.
CoxOptions	setSelection(SelectionStatement value) Sets the value of parameter 'selection': specifies the method and options for performing model selection.
CoxOptions	setSpline(Spline[] value) Sets the value of parameter 'spline': expands variables into spline bases whose form depends on the specified parameters.
CoxOptions	setStrata(java.lang.String value) Sets the value of parameter 'strata': names the variable that identifies the strata for a stratified analysis.
CoxOptions	setStratamissing(java.lang.Boolean value) Sets the value of parameter 'stratamissing'.
CoxOptions	setTable(Castable value) Sets the value of parameter 'table': specifies input data table.
CoxOptions	setWeight(java.lang.String value) Sets the value of parameter 'weight': names the numeric variable used to perform a weighted analysis of the data.

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

ACTION_SET_NAME

public static final java.lang.String ACTION_SET_NAME

See Also:

Constant Field Values

ACTION_NAME

public static final java.lang.String ACTION_NAME

See Also:

Constant Field Values

KEY_TABLE

public static final java.lang.String KEY_TABLE

See Also:

Constant Field Values

KEY_CLASS

public static final java.lang.String KEY_CLASS

See Also:

Constant Field Values

KEY_CLASSGLOBALOPTS

public static final java.lang.String KEY_CLASSGLOBALOPTS

See Also:

Constant Field Values

KEY_MODEL

public static final java.lang.String KEY_MODEL

See Also:

Constant Field Values

KEY_WEIGHT

public static final java.lang.String KEY_WEIGHT

See Also:

Constant Field Values

KEY_FREQ

public static final java.lang.String KEY_FREQ

See Also:

Constant Field Values

KEY_SELECTION

public static final java.lang.String KEY_SELECTION

See Also:

Constant Field Values

KEY_PARTBYVAR

public static final java.lang.String KEY_PARTBYVAR

See Also:

Constant Field Values

KEY_PARTBYFRAC

public static final java.lang.String KEY_PARTBYFRAC

See Also:

Constant Field Values

KEY_DISPLAY

public static final java.lang.String KEY_DISPLAY

See Also:

Constant Field Values

KEY_OUTPUTTABLES

public static final java.lang.String KEY_OUTPUTTABLES

See Also:

Constant Field Values

KEY_OUTPUT

public static final java.lang.String KEY_OUTPUT

See Also:

Constant Field Values

KEY_ALPHA

public static final java.lang.String KEY_ALPHA

See Also:

Constant Field Values

KEY_LASSORHO

public static final java.lang.String KEY_LASSORHO

See Also:

Constant Field Values

KEY_LASSOTOL

public static final java.lang.String KEY_LASSOTOL

See Also:

Constant Field Values

KEY_LASSOSTEPS

public static final java.lang.String KEY_LASSOSTEPS

See Also:

Constant Field Values

KEY_CLASSLEVELSPRINT

public static final java.lang.String KEY_CLASSLEVELSPRINT

See Also:

Constant Field Values

KEY_NCLASSLEVELSPRINT

public static final java.lang.String KEY_NCLASSLEVELSPRINT

See Also:

Constant Field Values

KEY_CODE

public static final java.lang.String KEY_CODE

See Also:

Constant Field Values

KEY_OPTIMIZATION

public static final java.lang.String KEY_OPTIMIZATION

See Also:

Constant Field Values

KEY_NOSTDERR

public static final java.lang.String KEY_NOSTDERR

See Also:

Constant Field Values

KEY_COVB

public static final java.lang.String KEY_COVB

See Also:

Constant Field Values

KEY_CORRB

public static final java.lang.String KEY_CORRB

See Also:

Constant Field Values

KEY_COLLECTION

public static final java.lang.String KEY_COLLECTION

See Also:

Constant Field Values

KEY_MULTIMEMBER

public static final java.lang.String KEY_MULTIMEMBER

See Also:

Constant Field Values

KEY_POLYNOMIAL

public static final java.lang.String KEY_POLYNOMIAL

See Also:

Constant Field Values

KEY_SPLINE

public static final java.lang.String KEY_SPLINE

See Also:

Constant Field Values

KEY_STRATA

public static final java.lang.String KEY_STRATA

See Also:

Constant Field Values

KEY_STRATAMISSING

public static final java.lang.String KEY_STRATAMISSING

See Also:

Constant Field Values

Constructor Detail

CoxOptions

public CoxOptions()

CoxOptions

public CoxOptions(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

getTable

public Castable getTable()

setTable

public CoxOptions setTable(Castable value)

Sets the value of parameter 'table': specifies input data table.

Parameters:

value - The value

Returns:

The options object

getClassParameter

public ClassStatement[] getClassParameter()

getClassVars

public ClassStatement[] getClassVars()

getNominal

public ClassStatement[] getNominal()

setClassParameter

public CoxOptions setClassParameter(ClassStatement[] value)

Sets the value of parameter 'class': names the classification variables to be used as explanatory variables in the analysis.

Parameters:

value - The value

Returns:

The options object

setClassVars

public CoxOptions setClassVars(ClassStatement[] value)

setNominal

public CoxOptions setNominal(ClassStatement[] value)

getClassglobalopts

public Classopts getClassglobalopts()

setClassglobalopts

public CoxOptions setClassglobalopts(Classopts value)

Sets the value of parameter 'classglobalopts': lists options that apply to all classification variables.

Parameters:

value - The value

Returns:

The options object

getModel

public Coxmodel getModel()

setModel

public CoxOptions setModel(Coxmodel value)

Sets the value of parameter 'model': names the dependent variable, explanatory effects and model options.

Parameters:

value - The value

Returns:

The options object

getWeight

public java.lang.String getWeight()

setWeight

public CoxOptions setWeight(java.lang.String value)

Sets the value of parameter 'weight': names the numeric variable used to perform a weighted analysis of the data.

Parameters:

value - The value

Returns:

The options object

getFreq

public java.lang.String getFreq()

setFreq

public CoxOptions setFreq(java.lang.String value)

Sets the value of parameter 'freq': names the numeric variable that contains the frequency of occurrence for each observation.

Parameters:

value - The value

Returns:

The options object

getSelection

public SelectionStatement getSelection()

setSelection

public CoxOptions setSelection(SelectionStatement value)

Sets the value of parameter 'selection': specifies the method and options for performing model selection.

Parameters:

value - The value

Returns:

The options object

getPartbyvar

public PartByVarStatement getPartbyvar()

setPartbyvar

public CoxOptions setPartbyvar(PartByVarStatement value)

Sets the value of parameter 'partbyvar': names the variable and its values used to partition the data into training, validation and testing roles.

Parameters:

value - The value

Returns:

The options object

getPartbyfrac

public PartByFracStatement getPartbyfrac()

setPartbyfrac

public CoxOptions setPartbyfrac(PartByFracStatement value)

Sets the value of parameter 'partbyfrac': specifies the fractions of the data to be used for validation and testing.

Parameters:

value - The value

Returns:

The options object

getDisplay

public DisplayTables getDisplay()

setDisplay

public CoxOptions setDisplay(DisplayTables value)

Sets the value of parameter 'display': specifies a list of result tables to send to the client for display.

Parameters:

value - The value

Returns:

The options object

getOutputTables

public OutputTables getOutputTables()

setOutputTables

public CoxOptions setOutputTables(OutputTables value)

Sets the value of parameter 'outputTables': lists the result table names that are saved as CAS tables on the server.

Parameters:

value - The value

Returns:

The options object

getOutput

public CoxOutputStatement getOutput()

setOutput

public CoxOptions setOutput(CoxOutputStatement value)

Sets the value of parameter 'output': creates a table on the server that contains observationwise statistics, which are computed after fitting the model.

Parameters:

value - The value

Returns:

The options object

getAlpha

public java.lang.Double getAlpha()

setAlpha

public CoxOptions setAlpha(java.lang.Double value)

Sets the value of parameter 'alpha': specifies the significance level used for the construction of all confidence intervals. The server default is 0.05.

Parameters:

value - The value

Returns:

The options object

getLassoRho

public java.lang.Double getLassoRho()

setLassoRho

public CoxOptions setLassoRho(java.lang.Double value)

Sets the value of parameter 'lassoRho': specifies the base regularization parameter for the LASSO method. The server default is 0.8.

Parameters:

value - The value

Returns:

The options object

getLassoTol

public java.lang.Double getLassoTol()

setLassoTol

public CoxOptions setLassoTol(java.lang.Double value)

Sets the value of parameter 'lassoTol': specifies the convergence criterion for the LASSO method. The server default is 1e-06.

Parameters:

value - The value

Returns:

The options object

getLassoSteps

public java.lang.Integer getLassoSteps()

setLassoSteps

public CoxOptions setLassoSteps(java.lang.Integer value)

Sets the value of parameter 'lassoSteps': specifies the maximum number of steps for the LASSO method. The server default is 20.

Parameters:

value - The value

Returns:

The options object

getClassLevelsPrint

public java.lang.Boolean getClassLevelsPrint()

setClassLevelsPrint

public CoxOptions setClassLevelsPrint(java.lang.Boolean value)

Sets the value of parameter 'classLevelsPrint': suppresses the display of class levels. The server default is TRUE.

Parameters:

value - The value

Returns:

The options object

getNClassLevelsPrint

public java.lang.Integer getNClassLevelsPrint()

setNClassLevelsPrint

public CoxOptions setNClassLevelsPrint(java.lang.Integer value)

Sets the value of parameter 'nClassLevelsPrint': limits the display of class levels. The value 0 suppresses all levels.

Parameters:

value - The value

Returns:

The options object

getCode

public Coxcodegen getCode()

setCode

public CoxOptions setCode(Coxcodegen value)

Sets the value of parameter 'code': writes SAS DATA step code for computing predicted values of the fitted model.

Parameters:

value - The value

Returns:

The options object

getOptimization

public OptimizationStatement getOptimization()

setOptimization

public CoxOptions setOptimization(OptimizationStatement value)

Sets the value of parameter 'optimization': specifies the technique and options for performing the optimization.

Parameters:

value - The value

Returns:

The options object

getNostderr

public java.lang.Boolean getNostderr()

setNostderr

public CoxOptions setNostderr(java.lang.Boolean value)

Sets the value of parameter 'nostderr': when set to True, the covariance matrix and any statistic that depends on it are not computed. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getCovB

public java.lang.Boolean getCovB()

setCovB

public CoxOptions setCovB(java.lang.Boolean value)

Sets the value of parameter 'covB': when set to True, displays the covariance matrix of the parameters. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getCorrB

public java.lang.Boolean getCorrB()

setCorrB

public CoxOptions setCorrB(java.lang.Boolean value)

Sets the value of parameter 'corrB': when set to True, displays the correlation matrix of the parameters. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getCollection

public Collection[] getCollection()

setCollection

public CoxOptions setCollection(Collection[] value)

Sets the value of parameter 'collection': defines a set of variables that are treated as a single effect that has multiple degrees of freedom.

Parameters:

value - The value

Returns:

The options object

getMultimember

public Multimember[] getMultimember()

setMultimember

public CoxOptions setMultimember(Multimember[] value)

Sets the value of parameter 'multimember': uses one or more classification variables specified in the vars parameter in such a way that each observation can be associated with one or more levels of the union of the levels of the classification variables.

Parameters:

value - The value

Returns:

The options object

getPolynomial

public Polynomial[] getPolynomial()

getPoly

public Polynomial[] getPoly()

setPolynomial

public CoxOptions setPolynomial(Polynomial[] value)

Sets the value of parameter 'polynomial': specifies a polynomial effect. All specified variables must be numeric. A design matrix column is generated for each term of the specified polynomial. By default, each of these terms is treated as a separate effect for the purpose of model building.

Parameters:

value - The value

Returns:

The options object

setPoly

public CoxOptions setPoly(Polynomial[] value)

getSpline

public Spline[] getSpline()

setSpline

public CoxOptions setSpline(Spline[] value)

Sets the value of parameter 'spline': expands variables into spline bases whose form depends on the specified parameters.

Parameters:

value - The value

Returns:

The options object

getStrata

public java.lang.String getStrata()

setStrata

public CoxOptions setStrata(java.lang.String value)

Sets the value of parameter 'strata': names the variable that identifies the strata for a stratified analysis.

Parameters:

value - The value

Returns:

The options object

getStratamissing

public java.lang.Boolean getStratamissing()

setStratamissing

public CoxOptions setStratamissing(java.lang.Boolean value)

Sets the value of parameter 'stratamissing'. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object