com.sas.cas.actions.panel

Class Panelmodel

java.lang.Object

com.sas.cas.CASActionOptions

com.sas.cas.CASGeneratedActionOptions

com.sas.cas.actions.panel.Panelmodel

All Implemented Interfaces:

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

public class Panelmodel
extends CASGeneratedActionOptions

Options for panel: Fits panel data regression models.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Panelmodel.DIST
static class	Panelmodel.LINK
static class	Panelmodel.TYPE

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_CENSOR
static java.lang.String	KEY_DEPVARS
static java.lang.String	KEY_DIST
static java.lang.String	KEY_EFFECTS
static java.lang.String	KEY_ENTRY
static java.lang.String	KEY_GROUP
static java.lang.String	KEY_INCLUDE
static java.lang.String	KEY_INFORMATIVE
static java.lang.String	KEY_LINK
static java.lang.String	KEY_METHOD
static java.lang.String	KEY_NOINT
static java.lang.String	KEY_OFFSET
static java.lang.String	KEY_START
static java.lang.String	KEY_SUBJECT
static java.lang.String	KEY_TRIAL
static java.lang.String	KEY_TYPE
static java.lang.String	KEY_VCOMP

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCensor()
Responsevar[]	getDepVar()
Responsevar[]	getDepVars()
Panelmodel.DIST	getDist()
Panelmodel.DIST	getDistribution()
Effect[]	getEffects()
java.lang.String	getEntry()
Effect[]	getGroup()
java.lang.Object	getInclude()
java.lang.Boolean	getInformative()
Panelmodel.LINK	getLink()
java.lang.String	getMethod()
java.lang.Boolean	getNoint()
java.lang.String	getOffset()
java.lang.Object	getServerDefaultValue(java.lang.String key) Gets the server default value, if known.
java.lang.Object	getStart()
Effect[]	getSubject()
Responsevar[]	getTarget()
java.lang.String	getTrial()
Panelmodel.TYPE	getType()
java.lang.String	getVcomp()
Panelmodel	setCensor(java.lang.String value) Sets the value of parameter 'censor': specifies the censor variable.
Panelmodel	setDepVar(Responsevar[] value)
Panelmodel	setDepVars(Responsevar[] value) Sets the value of parameter 'depVars': specifies a list of variables and variable-specific parameters to use as response variables in the modeling.
Panelmodel	setDist(Panelmodel.DIST value) Sets the value of parameter 'dist': specifies the response distribution for the model.
Panelmodel	setDistribution(Panelmodel.DIST value)
Panelmodel	setEffects(Effect[] value) Sets the value of parameter 'effects': specifies a list of effects that define the model.
Panelmodel	setEntry(java.lang.String value) Sets the value of parameter 'entry': specifies the entry variable.
Panelmodel	setGroup(Effect[] value) Sets the value of parameter 'group': defines an effect that specifies heterogeneity in the covariance structure of G for mixed models.
Panelmodel	setInclude(Effect[] value) Sets the value of parameter 'include' for alternative 2.
Panelmodel	setInclude(java.lang.Integer value) Sets the value of parameter 'include' for alternative 1.
Panelmodel	setInformative(java.lang.Boolean value) Sets the value of parameter 'informative': when set to True, models missing values by using extra model effects.
Panelmodel	setLink(Panelmodel.LINK value) Sets the value of parameter 'link': specifies the link function for the model.
Panelmodel	setMethod(java.lang.String value) Sets the value of parameter 'method'.
Panelmodel	setNoint(java.lang.Boolean value) Sets the value of parameter 'noint': when set to True, does not include the intercept term in the model.
Panelmodel	setOffset(java.lang.String value) Sets the value of parameter 'offset': specifies a numeric offset variable.
Panelmodel	setStart(Effect[] value) Sets the value of parameter 'start' for alternative 2.
Panelmodel	setStart(java.lang.Integer value) Sets the value of parameter 'start' for alternative 1.
Panelmodel	setSubject(Effect[] value) Sets the value of parameter 'subject': identifies the subjects in a mixed model.
Panelmodel	setTarget(Responsevar[] value)
Panelmodel	setTrial(java.lang.String value) Sets the value of parameter 'trial': specifies a positive numeric variable that is the number of trials.
Panelmodel	setType(Panelmodel.TYPE value) Sets the value of parameter 'type': specifies the type of model for actions that support multiple model specifications.
Panelmodel	setVcomp(java.lang.String value) Sets the value of parameter 'vcomp'.

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_DEPVARS

public static final java.lang.String KEY_DEPVARS

See Also:

Constant Field Values

KEY_EFFECTS

public static final java.lang.String KEY_EFFECTS

See Also:

Constant Field Values

KEY_TRIAL

public static final java.lang.String KEY_TRIAL

See Also:

Constant Field Values

KEY_OFFSET

public static final java.lang.String KEY_OFFSET

See Also:

Constant Field Values

KEY_NOINT

public static final java.lang.String KEY_NOINT

See Also:

Constant Field Values

KEY_INFORMATIVE

public static final java.lang.String KEY_INFORMATIVE

See Also:

Constant Field Values

KEY_DIST

public static final java.lang.String KEY_DIST

See Also:

Constant Field Values

KEY_LINK

public static final java.lang.String KEY_LINK

See Also:

Constant Field Values

KEY_TYPE

public static final java.lang.String KEY_TYPE

See Also:

Constant Field Values

KEY_CENSOR

public static final java.lang.String KEY_CENSOR

See Also:

Constant Field Values

KEY_SUBJECT

public static final java.lang.String KEY_SUBJECT

See Also:

Constant Field Values

KEY_GROUP

public static final java.lang.String KEY_GROUP

See Also:

Constant Field Values

KEY_START

public static final java.lang.String KEY_START

See Also:

Constant Field Values

KEY_INCLUDE

public static final java.lang.String KEY_INCLUDE

See Also:

Constant Field Values

KEY_ENTRY

public static final java.lang.String KEY_ENTRY

See Also:

Constant Field Values

KEY_METHOD

public static final java.lang.String KEY_METHOD

See Also:

Constant Field Values

KEY_VCOMP

public static final java.lang.String KEY_VCOMP

See Also:

Constant Field Values

Constructor Detail

Panelmodel

public Panelmodel()

Panelmodel

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

getDepVars

public Responsevar[] getDepVars()

getDepVar

public Responsevar[] getDepVar()

getTarget

public Responsevar[] getTarget()

setDepVars

public Panelmodel setDepVars(Responsevar[] value)

Sets the value of parameter 'depVars': specifies a list of variables and variable-specific parameters to use as response variables in the modeling. When variable-specific parameters are not needed, you can simplify the value of the parameter by specifying a single response variable name as a quoted string.

Parameters:

value - The value

Returns:

The options object

setDepVar

public Panelmodel setDepVar(Responsevar[] value)

setTarget

public Panelmodel setTarget(Responsevar[] value)

getEffects

public Effect[] getEffects()

setEffects

public Panelmodel setEffects(Effect[] value)

Sets the value of parameter 'effects': specifies a list of effects that define the model. Each term in this list is made up of variables specified in the vars parameter and their interaction (which can be NONE, CROSS, or BAR). When the interaction is BAR, it can be limited by the maxInteract parameter. Any term that consists of only the vars parameter can be simplified by specifying the list of variable names directly in the effect parameter.

Parameters:

value - The value

Returns:

The options object

getTrial

public java.lang.String getTrial()

setTrial

public Panelmodel setTrial(java.lang.String value)

Sets the value of parameter 'trial': specifies a positive numeric variable that is the number of trials. When you specify a trial variable, the response variable is called the events variable and it must contain the number of positive responses (or events).

Parameters:

value - The value

Returns:

The options object

getOffset

public java.lang.String getOffset()

setOffset

public Panelmodel setOffset(java.lang.String value)

Sets the value of parameter 'offset': specifies a numeric offset variable. This variable cannot be a classification variable, a response variable, or one of the explanatory variables.

Parameters:

value - The value

Returns:

The options object

getNoint

public java.lang.Boolean getNoint()

setNoint

public Panelmodel setNoint(java.lang.Boolean value)

Sets the value of parameter 'noint': when set to True, does not include the intercept term in the model. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getInformative

public java.lang.Boolean getInformative()

setInformative

public Panelmodel setInformative(java.lang.Boolean value)

Sets the value of parameter 'informative': when set to True, models missing values by using extra model effects. These effects consist of dummy variables that take the value 1 when the value of a continuous model variable involved in the effect is missing, and take the value 0 otherwise. The missing value in the original model effect is replaced by the average value of the effect for the nonmissing values. For classification variables, missing values are treated as valid levels. The server default is FALSE.

Parameters:

value - The value

Returns:

The options object

getDist

public Panelmodel.DIST getDist()

getDistribution

public Panelmodel.DIST getDistribution()

setDist

public Panelmodel setDist(Panelmodel.DIST value)

Sets the value of parameter 'dist': specifies the response distribution for the model. The server default is DIST.BETA.

Parameters:

value - The value

Returns:

The options object

setDistribution

public Panelmodel setDistribution(Panelmodel.DIST value)

getLink

public Panelmodel.LINK getLink()

setLink

public Panelmodel setLink(Panelmodel.LINK value)

Sets the value of parameter 'link': specifies the link function for the model. The server default is LINK.CLOGLOG.

Parameters:

value - The value

Returns:

The options object

getType

public Panelmodel.TYPE getType()

setType

public Panelmodel setType(Panelmodel.TYPE value)

Sets the value of parameter 'type': specifies the type of model for actions that support multiple model specifications. Examples of such actions are mixed models that include both fixed and random effects and zero-inflated models that specify both main and zero models. The server default is TYPE.CNTMODEL.

Parameters:

value - The value

Returns:

The options object

getCensor

public java.lang.String getCensor()

setCensor

public Panelmodel setCensor(java.lang.String value)

Sets the value of parameter 'censor': specifies the censor variable.

Parameters:

value - The value

Returns:

The options object

getSubject

public Effect[] getSubject()

setSubject

public Panelmodel setSubject(Effect[] value)

Sets the value of parameter 'subject': identifies the subjects in a mixed model.

Parameters:

value - The value

Returns:

The options object

getGroup

public Effect[] getGroup()

setGroup

public Panelmodel setGroup(Effect[] value)

Sets the value of parameter 'group': defines an effect that specifies heterogeneity in the covariance structure of G for mixed models. All observations that have the same level of the group effect have the same covariance parameters. Each new level of the group effect produces a new set of covariance parameters that has the same structure as the original group.

Parameters:

value - The value

Returns:

The options object

getStart

public java.lang.Object getStart()

setStart

public Panelmodel setStart(java.lang.Integer value)

Sets the value of parameter 'start' for alternative 1. The server default is 0.

Parameters:

value - The value

Returns:

The options object

setStart

public Panelmodel setStart(Effect[] value)

Sets the value of parameter 'start' for alternative 2.

Parameters:

value - The value

Returns:

The options object

getInclude

public java.lang.Object getInclude()

setInclude

public Panelmodel setInclude(java.lang.Integer value)

Sets the value of parameter 'include' for alternative 1. The server default is 0.

Parameters:

value - The value

Returns:

The options object

setInclude

public Panelmodel setInclude(Effect[] value)

Sets the value of parameter 'include' for alternative 2.

Parameters:

value - The value

Returns:

The options object

getEntry

public java.lang.String getEntry()

setEntry

public Panelmodel setEntry(java.lang.String value)

Sets the value of parameter 'entry': specifies the entry variable.

Parameters:

value - The value

Returns:

The options object

getMethod

public java.lang.String getMethod()

setMethod

public Panelmodel setMethod(java.lang.String value)

Sets the value of parameter 'method'.

Parameters:

value - The value

Returns:

The options object

getVcomp

public java.lang.String getVcomp()

setVcomp

public Panelmodel setVcomp(java.lang.String value)

Sets the value of parameter 'vcomp'.

Parameters:

value - The value

Returns:

The options object