Common Parameter: multimember

CASL Syntax

multimember={{
details=TRUE | FALSE,
required parameter name="string",
noEffect=TRUE | FALSE,
stdize=TRUE | FALSE,
required parameter vars={"variable-name-1" <, "variable-name-2", ...>},
weight={"variable-name-1" <, "variable-name-2", ...>}
}, {...}}

Parameter Descriptions

details=TRUE | FALSE

when set to True, requests a table that shows additional details that are related to this effect.

Default FALSE
* name="string"

specifies the name of the effect.

noEffect=TRUE | FALSE

when set to True, sets to zero the values in the design matrix for columns that correspond to observations whose levels of the multimember variables are all missing.

Default FALSE
stdize=TRUE | FALSE

when set to True, scales the entries in the design matrix that correspond to the multimember effect to have a sum of one for each observation.

Default FALSE
* vars={"variable-name-1" <, "variable-name-2", ...>}

specifies classification variables for the multimember effect. The levels of a multimember effect consist of the union of formatted values of the variables that define this effect. Each such level contributes one column to the design matrix. For each observation, the value that corresponds to each level of the multimember effect in the design matrix is the number of times that this level occurs for the observation.

weight={"variable-name-1" <, "variable-name-2", ...>}

specifies numeric variables by which to weigh the contributions of the classification variables that define the multimember effect. The number of weight variables must match the number of classification variables that define the effect.

Lua Syntax

multimember={{
details=true | false,
required parameter name="string",
noEffect=true | false,
stdize=true | false,
required parameter vars={"variable-name-1" <, "variable-name-2", ...>},
weight={"variable-name-1" <, "variable-name-2", ...>}
}, {...}}

Parameter Descriptions

details=true | false

when set to True, requests a table that shows additional details that are related to this effect.

Default false
* name="string"

specifies the name of the effect.

noEffect=true | false

when set to True, sets to zero the values in the design matrix for columns that correspond to observations whose levels of the multimember variables are all missing.

Default false
stdize=true | false

when set to True, scales the entries in the design matrix that correspond to the multimember effect to have a sum of one for each observation.

Default false
* vars={"variable-name-1" <, "variable-name-2", ...>}

specifies classification variables for the multimember effect. The levels of a multimember effect consist of the union of formatted values of the variables that define this effect. Each such level contributes one column to the design matrix. For each observation, the value that corresponds to each level of the multimember effect in the design matrix is the number of times that this level occurs for the observation.

weight={"variable-name-1" <, "variable-name-2", ...>}

specifies numeric variables by which to weigh the contributions of the classification variables that define the multimember effect. The number of weight variables must match the number of classification variables that define the effect.

Python Syntax

multimember=[{
"details":True | False,
required parameter "name":"string",
"noEffect":True | False,
"stdize":True | False,
required parameter "vars":["variable-name-1" <, "variable-name-2", ...>],
"weight":["variable-name-1" <, "variable-name-2", ...>]
}<, {...}>]

Parameter Descriptions

"details":True | False

when set to True, requests a table that shows additional details that are related to this effect.

Default False
* "name":"string"

specifies the name of the effect.

"noEffect":True | False

when set to True, sets to zero the values in the design matrix for columns that correspond to observations whose levels of the multimember variables are all missing.

Default False
"stdize":True | False

when set to True, scales the entries in the design matrix that correspond to the multimember effect to have a sum of one for each observation.

Default False
* "vars":["variable-name-1" <, "variable-name-2", ...>]

specifies classification variables for the multimember effect. The levels of a multimember effect consist of the union of formatted values of the variables that define this effect. Each such level contributes one column to the design matrix. For each observation, the value that corresponds to each level of the multimember effect in the design matrix is the number of times that this level occurs for the observation.

"weight":["variable-name-1" <, "variable-name-2", ...>]

specifies numeric variables by which to weigh the contributions of the classification variables that define the multimember effect. The number of weight variables must match the number of classification variables that define the effect.

R Syntax

multimember=list( list(
details=TRUE | FALSE,
required parameter name="string",
noEffect=TRUE | FALSE,
stdize=TRUE | FALSE,
required parameter vars=list("variable-name-1" <, "variable-name-2", ...>),
weight=list("variable-name-1" <, "variable-name-2", ...>)
) <, list(...)>)

Parameter Descriptions

details=TRUE | FALSE

when set to True, requests a table that shows additional details that are related to this effect.

Default FALSE
* name="string"

specifies the name of the effect.

noEffect=TRUE | FALSE

when set to True, sets to zero the values in the design matrix for columns that correspond to observations whose levels of the multimember variables are all missing.

Default FALSE
stdize=TRUE | FALSE

when set to True, scales the entries in the design matrix that correspond to the multimember effect to have a sum of one for each observation.

Default FALSE
* vars=list("variable-name-1" <, "variable-name-2", ...>)

specifies classification variables for the multimember effect. The levels of a multimember effect consist of the union of formatted values of the variables that define this effect. Each such level contributes one column to the design matrix. For each observation, the value that corresponds to each level of the multimember effect in the design matrix is the number of times that this level occurs for the observation.

weight=list("variable-name-1" <, "variable-name-2", ...>)

specifies numeric variables by which to weigh the contributions of the classification variables that define the multimember effect. The number of weight variables must match the number of classification variables that define the effect.

Last updated: November 23, 2025