Common Parameter: classopts

CASL Syntax

classopts={
countMissing=TRUE | FALSE,
descending=TRUE | FALSE,
ignoreMissing=TRUE | FALSE,
levelizeRaw=TRUE | FALSE,
maxLev=integer,
order="FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL",
param="BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE",
ref="FIRST" | "LAST" | double | "string",
split=TRUE | FALSE
}

Parameter Descriptions

countMissing=TRUE | FALSE

when set to True, treats missing as a valid level for this variable.

DefaultFALSE
descending=TRUE | FALSE

when set to True, reverses the sort order that is imposed by the order parameter.

DefaultFALSE
ignoreMissing=TRUE | FALSE

when set to True, ignores the fact that some variables in the observation have missing values and honors the nonmissing values for other variables in that observation.

DefaultFALSE
levelizeRaw=TRUE | FALSE

when set to True, bases levelization for this variable on raw values.

DefaultFALSE
maxLev=integer

specifies the maximum number of levels. A value of 0 means an unlimited number of levels.

Default0
Minimum value0
order="FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL"

specifies the sort order for the levels of the classification variable. This ordering determines which parameters in the model correspond to each level in the data.

param="BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE"

specifies the parameterization method for the classification variable or variables. The default is GLM when none of the variables specified in the vars parameter includes a param parameter; otherwise, the default is REFERENCE.

ref="FIRST" | "LAST" | double | "string"

specifies the reference level to use when you specify a nonsingular parameterization in the param parameter. For an individual variable, you can specify the level of the variable to use as the reference level. If the action supports the global class options parameter, then you can specify FIRST or LAST.

split=TRUE | FALSE

enables selection of columns of the design matrix that correspond to any effect that contains a split classification variable to enter or leave a model independently of the other design columns of that effect.

DefaultFALSE

Lua Syntax

classopts={
countMissing=true | false,
descending=true | false,
ignoreMissing=true | false,
levelizeRaw=true | false,
maxLev=integer,
order="FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL",
param="BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE",
ref="FIRST" | "LAST" | double | "string",
split=true | false
}

Parameter Descriptions

countMissing=true | false

when set to True, treats missing as a valid level for this variable.

Defaultfalse
descending=true | false

when set to True, reverses the sort order that is imposed by the order parameter.

Defaultfalse
ignoreMissing=true | false

when set to True, ignores the fact that some variables in the observation have missing values and honors the nonmissing values for other variables in that observation.

Defaultfalse
levelizeRaw=true | false

when set to True, bases levelization for this variable on raw values.

Defaultfalse
maxLev=integer

specifies the maximum number of levels. A value of 0 means an unlimited number of levels.

Default0
Minimum value0
order="FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL"

specifies the sort order for the levels of the classification variable. This ordering determines which parameters in the model correspond to each level in the data.

param="BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE"

specifies the parameterization method for the classification variable or variables. The default is GLM when none of the variables specified in the vars parameter includes a param parameter; otherwise, the default is REFERENCE.

ref="FIRST" | "LAST" | double | "string"

specifies the reference level to use when you specify a nonsingular parameterization in the param parameter. For an individual variable, you can specify the level of the variable to use as the reference level. If the action supports the global class options parameter, then you can specify FIRST or LAST.

split=true | false

enables selection of columns of the design matrix that correspond to any effect that contains a split classification variable to enter or leave a model independently of the other design columns of that effect.

Defaultfalse

Python Syntax

classopts={
"countMissing":True | False,
"descending":True | False,
"ignoreMissing":True | False,
"levelizeRaw":True | False,
"maxLev":integer,
"order":"FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL",
"param":"BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE",
"ref":"FIRST" | "LAST" | double | "string",
"split":True | False
}

Parameter Descriptions

"countMissing":True | False

when set to True, treats missing as a valid level for this variable.

DefaultFalse
"descending":True | False

when set to True, reverses the sort order that is imposed by the order parameter.

DefaultFalse
"ignoreMissing":True | False

when set to True, ignores the fact that some variables in the observation have missing values and honors the nonmissing values for other variables in that observation.

DefaultFalse
"levelizeRaw":True | False

when set to True, bases levelization for this variable on raw values.

DefaultFalse
"maxLev":integer

specifies the maximum number of levels. A value of 0 means an unlimited number of levels.

Default0
Minimum value0
"order":"FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL"

specifies the sort order for the levels of the classification variable. This ordering determines which parameters in the model correspond to each level in the data.

"param":"BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE"

specifies the parameterization method for the classification variable or variables. The default is GLM when none of the variables specified in the vars parameter includes a param parameter; otherwise, the default is REFERENCE.

"ref":"FIRST" | "LAST" | double | "string"

specifies the reference level to use when you specify a nonsingular parameterization in the param parameter. For an individual variable, you can specify the level of the variable to use as the reference level. If the action supports the global class options parameter, then you can specify FIRST or LAST.

"split":True | False

enables selection of columns of the design matrix that correspond to any effect that contains a split classification variable to enter or leave a model independently of the other design columns of that effect.

DefaultFalse

R Syntax

classopts=list(
countMissing=TRUE | FALSE,
descending=TRUE | FALSE,
ignoreMissing=TRUE | FALSE,
levelizeRaw=TRUE | FALSE,
maxLev=integer,
order="FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL",
param="BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE",
ref="FIRST" | "LAST" | double | "string",
split=TRUE | FALSE
)

Parameter Descriptions

countMissing=TRUE | FALSE

when set to True, treats missing as a valid level for this variable.

DefaultFALSE
descending=TRUE | FALSE

when set to True, reverses the sort order that is imposed by the order parameter.

DefaultFALSE
ignoreMissing=TRUE | FALSE

when set to True, ignores the fact that some variables in the observation have missing values and honors the nonmissing values for other variables in that observation.

DefaultFALSE
levelizeRaw=TRUE | FALSE

when set to True, bases levelization for this variable on raw values.

DefaultFALSE
maxLev=integer

specifies the maximum number of levels. A value of 0 means an unlimited number of levels.

Default0
Minimum value0
order="FORMATTED" | "FREQ" | "FREQFORMATTED" | "FREQINTERNAL" | "INTERNAL"

specifies the sort order for the levels of the classification variable. This ordering determines which parameters in the model correspond to each level in the data.

param="BTH" | "EFFECT" | "GLM" | "ORDINAL" | "ORTHBTH" | "ORTHEFFECT" | "ORTHORDINAL" | "ORTHPOLY" | "ORTHREF" | "POLYNOMIAL" | "REFERENCE"

specifies the parameterization method for the classification variable or variables. The default is GLM when none of the variables specified in the vars parameter includes a param parameter; otherwise, the default is REFERENCE.

ref="FIRST" | "LAST" | double | "string"

specifies the reference level to use when you specify a nonsingular parameterization in the param parameter. For an individual variable, you can specify the level of the variable to use as the reference level. If the action supports the global class options parameter, then you can specify FIRST or LAST.

split=TRUE | FALSE

enables selection of columns of the design matrix that correspond to any effect that contains a split classification variable to enter or leave a model independently of the other design columns of that effect.

DefaultFALSE
Last updated: September 09, 2021