Graphical Variable Clustering Action Set

Provides an action for performing variable clustering and providing undirected network for mining relationship among variables

gvarcluster Action

Provides an action for performing variable clustering and providing undirected network for mining relationship among variables.

CASL Syntax

gVarCluster.gvarcluster <result=results> <status=rc> /
attributes={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
collection={{
details=TRUE | FALSE,
required parameter name="string",
required parameter vars={"variable-name-1" <, "variable-name-2", ...>}
}, {...}},
diagnostics={
eyecatcher="string"
},
display={
caseSensitive=TRUE | FALSE,
exclude=TRUE | FALSE,
excludeAll=TRUE | FALSE,
keyIsPath=TRUE | FALSE,
names={"string-1" <, "string-2", ...>},
pathType="LABEL" | "NAME",
traceNames=TRUE | FALSE
},
exact=TRUE | FALSE,
freq="variable-name",
inputs={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
maxIter=64-bit-integer,
maxMember=64-bit-integer,
maxSteps=64-bit-integer,
minCluster=64-bit-integer,
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", ...>}
}, {...}},
nominals={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
outCP={
required parameter casOut={
caslib="string"
compress=TRUE | FALSE
indexVars={"variable-name-1" <, "variable-name-2", ...>}
label="string"
lifetime=64-bit-integer
maxMemSize=64-bit-integer
memoryFormat="DVR" | "INHERIT" | "STANDARD"
name="table-name"
promote=TRUE | FALSE
replace=TRUE | FALSE
replication=integer
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"
threadBlockSize=64-bit-integer
timeStamp="string"
where={"string-1" <, "string-2", ...>}
},
eps=double,
list=TRUE | FALSE
},
outEdge={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outputTables={
groupByVarsRaw=TRUE | FALSE,
includeAll=TRUE | FALSE,
names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},
repeated=TRUE | FALSE,
replace=TRUE | FALSE
},
outTree={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outVert={
caslib="string",
compress=TRUE | FALSE,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
polynomial={{
degree=integer,
details=TRUE | FALSE,
labelStyle={
expand=TRUE | FALSE
exponent="string"
includeName=TRUE | FALSE
productSymbol="NONE" | "string"
},
mDegree=integer,
required parameter name="string",
noSeparate=TRUE | FALSE,
standardize={
method="MOMENTS" | "MRANGE" | "WMOMENTS"
options="CENTER" | "CENTERSCALE" | "NONE" | "SCALE"
prefix="NONE" | "string"
},
required parameter vars={"variable-name-1" <, "variable-name-2", ...>}
}, {...}},
rho=double,
select="ADJBIC" | "CV" | "NONE" | "PENALIZED",
stop=64-bit-integer,
required parameter table={
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=TRUE | FALSE,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
target="string",
weight="variable-name",
xTol=double
;
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the settings for an input table.

Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outCP

required parametercasOut

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

 outEdge

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

 outTree

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

 outVert

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

 outputTables

names

lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

attributes={{casinvardesc-1} <, {casinvardesc-2}, ...>}

changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.

For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias attribute

collection={{collection-1} <, {collection-2}, ...>}

defines a set of variables that are treated as a single effect that has multiple degrees of freedom.

The collection value can be one or more of the following:

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.

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

specifies a set of variables that are treated as a single effect that has multiple degrees of freedom. The columns in the design matrix that are contributed by a collection effect are the design columns of its constituent variables in the order in which they appear in the definition of the collection effect.

diagnostics={_diagnostics}

eyecatcher="string"

specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.

display={displayTables}

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

exact=TRUE | FALSE

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Alias noblock
Default FALSE

freq="variable-name"

names the numeric variable that contains the frequency of occurrence for each observation.

inputs={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies variables to use for analysis.

For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias input

maxIter=64-bit-integer

specifies the maximum number of iterations for estimating the sparse precision covariance matrix by using coordinate descent.

Default 50
Range 1–100000

maxMember=64-bit-integer

stops the action when the number of members within any cluster is greater than or equal to the specified value.

Range 1–100000

maxSteps=64-bit-integer

specifies the maximum number of clustering steps.

Default 3
Range 1–50

minCluster=64-bit-integer

stops the action when the number of clusters is less than or equal to the specified value.

Default 3
Range 1–100000

multimember={{multimember-1} <, {multimember-2}, ...>}

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.

For more information about specifying the multimember parameter, see the common multimember parameter (Appendix A: Common Parameters).

nominals={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies nominal variables to use for analysis.

For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias nominal

outCP={OutputCPStatement}

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

The OutputCPStatement value can be one or more of the following:

* casOut={casouttable}

specifies the output table.

For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

eps=double

specifies an epsilon value such that matrix entries that have an absolute value smaller than epsilon are ignored in the output. You must specify the list parameter when you specify the eps parameter.

Default 0
Minimum value 0
list=TRUE | FALSE

when set to True, outputs the symmetric matrix in the list-of-lists (LIL) format.

Default FALSE

outEdge={casouttable}

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

For more information about specifying the outEdge parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

Alias displayOut

outTree={casouttable}

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

For more information about specifying the outTree parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outVert={casouttable}

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

For more information about specifying the outVert parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

polynomial={{polynomial-1} <, {polynomial-2}, ...>}

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.

For more information about specifying the polynomial parameter, see the common polynomial parameter (Appendix A: Common Parameters).

Alias poly

rho=double

specifies the value of rho that determines the sequence of regulation parameters [the first power of rho, the second power of rho, and so on], that are used on sequential clustering steps.

Default 0.8

select="ADJBIC" | "CV" | "NONE" | "PENALIZED"

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Default NONE

stop=64-bit-integer

requests that the action stop if the clustering results do not change in the previous number of consecutive step that is specified in this parameter.

Default 3
Range 2–100

* table={castable}

specifies the settings for an input table.

For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

target="string"

specifies the target variable to use for analysis.

weight="variable-name"

names the numeric variable to use to perform a weighted analysis of the data.

xTol=double

specifies the minimal absolute tolerance at which an iteration stops.

Default 0.001
Minimum value 1E-12

gvarcluster Action

Provides an action for performing variable clustering and providing undirected network for mining relationship among variables.

Lua Syntax

results, info = s:gVarCluster_gvarcluster{
attributes={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
collection={{
details=true | false,
required parameter name="string",
required parameter vars={"variable-name-1" <, "variable-name-2", ...>}
}, {...}},
diagnostics={
eyecatcher="string"
},
display={
caseSensitive=true | false,
exclude=true | false,
excludeAll=true | false,
keyIsPath=true | false,
names={"string-1" <, "string-2", ...>},
pathType="LABEL" | "NAME",
traceNames=true | false
},
exact=true | false,
freq="variable-name",
inputs={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
maxIter=64-bit-integer,
maxMember=64-bit-integer,
maxSteps=64-bit-integer,
minCluster=64-bit-integer,
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", ...>}
}, {...}},
nominals={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
outCP={
required parameter casOut={
caslib="string"
compress=true | false
indexVars={"variable-name-1" <, "variable-name-2", ...>}
label="string"
lifetime=64-bit-integer
maxMemSize=64-bit-integer
memoryFormat="DVR" | "INHERIT" | "STANDARD"
name="table-name"
promote=true | false
replace=true | false
replication=integer
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"
threadBlockSize=64-bit-integer
timeStamp="string"
where={"string-1" <, "string-2", ...>}
},
eps=double,
list=true | false
},
outEdge={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=true | false,
replace=true | false,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outputTables={
groupByVarsRaw=true | false,
includeAll=true | false,
names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},
repeated=true | false,
replace=true | false
},
outTree={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=true | false,
replace=true | false,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
outVert={
caslib="string",
compress=true | false,
indexVars={"variable-name-1" <, "variable-name-2", ...>},
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=true | false,
replace=true | false,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where={"string-1" <, "string-2", ...>}
},
polynomial={{
degree=integer,
details=true | false,
labelStyle={
expand=true | false
exponent="string"
includeName=true | false
productSymbol="NONE" | "string"
},
mDegree=integer,
required parameter name="string",
noSeparate=true | false,
standardize={
method="MOMENTS" | "MRANGE" | "WMOMENTS"
options="CENTER" | "CENTERSCALE" | "NONE" | "SCALE"
prefix="NONE" | "string"
},
required parameter vars={"variable-name-1" <, "variable-name-2", ...>}
}, {...}},
rho=double,
select="ADJBIC" | "CV" | "NONE" | "PENALIZED",
stop=64-bit-integer,
required parameter table={
caslib="string",
computedOnDemand=true | false,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=true | false,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
target="string",
weight="variable-name",
xTol=double
}
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the settings for an input table.

Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outCP

required parametercasOut

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

 outEdge

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

 outTree

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

 outVert

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

 outputTables

names

lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

attributes={{casinvardesc-1} <, {casinvardesc-2}, ...>}

changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.

For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias attribute

collection={{collection-1} <, {collection-2}, ...>}

defines a set of variables that are treated as a single effect that has multiple degrees of freedom.

The collection value can be one or more of the following:

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.

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

specifies a set of variables that are treated as a single effect that has multiple degrees of freedom. The columns in the design matrix that are contributed by a collection effect are the design columns of its constituent variables in the order in which they appear in the definition of the collection effect.

diagnostics={_diagnostics}

eyecatcher="string"

specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.

display={displayTables}

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

exact=true | false

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Alias noblock
Default false

freq="variable-name"

names the numeric variable that contains the frequency of occurrence for each observation.

inputs={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies variables to use for analysis.

For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias input

maxIter=64-bit-integer

specifies the maximum number of iterations for estimating the sparse precision covariance matrix by using coordinate descent.

Default 50
Range 1–100000

maxMember=64-bit-integer

stops the action when the number of members within any cluster is greater than or equal to the specified value.

Range 1–100000

maxSteps=64-bit-integer

specifies the maximum number of clustering steps.

Default 3
Range 1–50

minCluster=64-bit-integer

stops the action when the number of clusters is less than or equal to the specified value.

Default 3
Range 1–100000

multimember={{multimember-1} <, {multimember-2}, ...>}

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.

For more information about specifying the multimember parameter, see the common multimember parameter (Appendix A: Common Parameters).

nominals={{casinvardesc-1} <, {casinvardesc-2}, ...>}

specifies nominal variables to use for analysis.

For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias nominal

outCP={OutputCPStatement}

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

The OutputCPStatement value can be one or more of the following:

* casOut={casouttable}

specifies the output table.

For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

eps=double

specifies an epsilon value such that matrix entries that have an absolute value smaller than epsilon are ignored in the output. You must specify the list parameter when you specify the eps parameter.

Default 0
Minimum value 0
list=true | false

when set to True, outputs the symmetric matrix in the list-of-lists (LIL) format.

Default false

outEdge={casouttable}

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

For more information about specifying the outEdge parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

Alias displayOut

outTree={casouttable}

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

For more information about specifying the outTree parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outVert={casouttable}

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

For more information about specifying the outVert parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

polynomial={{polynomial-1} <, {polynomial-2}, ...>}

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.

For more information about specifying the polynomial parameter, see the common polynomial parameter (Appendix A: Common Parameters).

Alias poly

rho=double

specifies the value of rho that determines the sequence of regulation parameters [the first power of rho, the second power of rho, and so on], that are used on sequential clustering steps.

Default 0.8

select="ADJBIC" | "CV" | "NONE" | "PENALIZED"

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Default NONE

stop=64-bit-integer

requests that the action stop if the clustering results do not change in the previous number of consecutive step that is specified in this parameter.

Default 3
Range 2–100

* table={castable}

specifies the settings for an input table.

For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

target="string"

specifies the target variable to use for analysis.

weight="variable-name"

names the numeric variable to use to perform a weighted analysis of the data.

xTol=double

specifies the minimal absolute tolerance at which an iteration stops.

Default 0.001
Minimum value 1E-12

gvarcluster Action

Provides an action for performing variable clustering and providing undirected network for mining relationship among variables.

Python Syntax

results=s.gVarCluster.gvarcluster(
attributes=[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
collection=[{
"details":True | False,
required parameter "name":"string",
required parameter "vars":["variable-name-1" <, "variable-name-2", ...>]
}<, {...}>],
diagnostics={
"eyecatcher":"string"
},
display={
"caseSensitive":True | False,
"exclude":True | False,
"excludeAll":True | False,
"keyIsPath":True | False,
"names":["string-1" <, "string-2", ...>],
"pathType":"LABEL" | "NAME",
"traceNames":True | False
},
exact=True | False,
freq="variable-name",
inputs=[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
maxIter=64-bit-integer,
maxMember=64-bit-integer,
maxSteps=64-bit-integer,
minCluster=64-bit-integer,
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", ...>]
}<, {...}>],
nominals=[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
outCP={
required parameter "casOut":{
"caslib":"string"
"compress":True | False
"indexVars":["variable-name-1" <, "variable-name-2", ...>]
"label":"string"
"lifetime":64-bit-integer
"maxMemSize":64-bit-integer
"memoryFormat":"DVR" | "INHERIT" | "STANDARD"
"name":"table-name"
"promote":True | False
"replace":True | False
"replication":integer
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE"
"threadBlockSize":64-bit-integer
"timeStamp":"string"
"where":["string-1" <, "string-2", ...>]
},
"eps":double,
"list":True | False
},
outEdge={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"lifetime":64-bit-integer,
"maxMemSize":64-bit-integer,
"memoryFormat":"DVR" | "INHERIT" | "STANDARD",
"name":"table-name",
"promote":True | False,
"replace":True | False,
"replication":integer,
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",
"threadBlockSize":64-bit-integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
outputTables={
"groupByVarsRaw":True | False,
"includeAll":True | False,
"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>},
"repeated":True | False,
"replace":True | False
},
outTree={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"lifetime":64-bit-integer,
"maxMemSize":64-bit-integer,
"memoryFormat":"DVR" | "INHERIT" | "STANDARD",
"name":"table-name",
"promote":True | False,
"replace":True | False,
"replication":integer,
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",
"threadBlockSize":64-bit-integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
outVert={
"caslib":"string",
"compress":True | False,
"indexVars":["variable-name-1" <, "variable-name-2", ...>],
"label":"string",
"lifetime":64-bit-integer,
"maxMemSize":64-bit-integer,
"memoryFormat":"DVR" | "INHERIT" | "STANDARD",
"name":"table-name",
"promote":True | False,
"replace":True | False,
"replication":integer,
"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",
"threadBlockSize":64-bit-integer,
"timeStamp":"string",
"where":["string-1" <, "string-2", ...>]
},
polynomial=[{
"degree":integer,
"details":True | False,
"labelStyle":{
"expand":True | False
"exponent":"string"
"includeName":True | False
"productSymbol":"NONE" | "string"
},
"mDegree":integer,
required parameter "name":"string",
"noSeparate":True | False,
"standardize":{
"method":"MOMENTS" | "MRANGE" | "WMOMENTS"
"options":"CENTER" | "CENTERSCALE" | "NONE" | "SCALE"
"prefix":"NONE" | "string"
},
required parameter "vars":["variable-name-1" <, "variable-name-2", ...>]
}<, {...}>],
rho=double,
select="ADJBIC" | "CV" | "NONE" | "PENALIZED",
stop=64-bit-integer,
required parameter table={
"caslib":"string",
"computedOnDemand":True | False,
"computedVars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"computedVarsProgram":"string",
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
"groupBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"groupByMode":"NOSORT" | "REDISTRIBUTE",
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter "name":"table-name",
"orderBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"singlePass":True | False,
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"where":"where-expression",
"whereTable":{
"casLib":"string"
"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter "name":"table-name"
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>]
"where":"where-expression"
}
},
target="string",
weight="variable-name",
xTol=double
)
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the settings for an input table.

Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outCP

required parametercasOut

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

 outEdge

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

 outTree

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

 outVert

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

 outputTables

names

lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

attributes=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.

For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias attribute

collection=[{collection-1} <, {collection-2}, ...>]

defines a set of variables that are treated as a single effect that has multiple degrees of freedom.

The collection value can be one or more of the following:

"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.

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

specifies a set of variables that are treated as a single effect that has multiple degrees of freedom. The columns in the design matrix that are contributed by a collection effect are the design columns of its constituent variables in the order in which they appear in the definition of the collection effect.

diagnostics={_diagnostics}

"eyecatcher":"string"

specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.

display={displayTables}

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

exact=True | False

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Alias noblock
Default False

freq="variable-name"

names the numeric variable that contains the frequency of occurrence for each observation.

inputs=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies variables to use for analysis.

For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias input

maxIter=64-bit-integer

specifies the maximum number of iterations for estimating the sparse precision covariance matrix by using coordinate descent.

Default 50
Range 1–100000

maxMember=64-bit-integer

stops the action when the number of members within any cluster is greater than or equal to the specified value.

Range 1–100000

maxSteps=64-bit-integer

specifies the maximum number of clustering steps.

Default 3
Range 1–50

minCluster=64-bit-integer

stops the action when the number of clusters is less than or equal to the specified value.

Default 3
Range 1–100000

multimember=[{multimember-1} <, {multimember-2}, ...>]

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.

For more information about specifying the multimember parameter, see the common multimember parameter (Appendix A: Common Parameters).

nominals=[{casinvardesc-1} <, {casinvardesc-2}, ...>]

specifies nominal variables to use for analysis.

For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias nominal

outCP={OutputCPStatement}

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

The OutputCPStatement value can be one or more of the following:

* "casOut":{casouttable}

specifies the output table.

For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

"eps":double

specifies an epsilon value such that matrix entries that have an absolute value smaller than epsilon are ignored in the output. You must specify the list parameter when you specify the eps parameter.

Default 0
Minimum value 0
"list":True | False

when set to True, outputs the symmetric matrix in the list-of-lists (LIL) format.

Default False

outEdge={casouttable}

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

For more information about specifying the outEdge parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputTables={outputTables}

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

Alias displayOut

outTree={casouttable}

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

For more information about specifying the outTree parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outVert={casouttable}

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

For more information about specifying the outVert parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

polynomial=[{polynomial-1} <, {polynomial-2}, ...>]

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.

For more information about specifying the polynomial parameter, see the common polynomial parameter (Appendix A: Common Parameters).

Alias poly

rho=double

specifies the value of rho that determines the sequence of regulation parameters [the first power of rho, the second power of rho, and so on], that are used on sequential clustering steps.

Default 0.8

select="ADJBIC" | "CV" | "NONE" | "PENALIZED"

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Default NONE

stop=64-bit-integer

requests that the action stop if the clustering results do not change in the previous number of consecutive step that is specified in this parameter.

Default 3
Range 2–100

* table={castable}

specifies the settings for an input table.

For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

target="string"

specifies the target variable to use for analysis.

weight="variable-name"

names the numeric variable to use to perform a weighted analysis of the data.

xTol=double

specifies the minimal absolute tolerance at which an iteration stops.

Default 0.001
Minimum value 1E-12

gvarcluster Action

Provides an action for performing variable clustering and providing undirected network for mining relationship among variables.

R Syntax

results <– cas.gVarCluster.gvarcluster(s,
attributes=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
collection=list( list(
details=TRUE | FALSE,
required parameter name="string",
required parameter vars=list("variable-name-1" <, "variable-name-2", ...>)
) <, list(...)>),
diagnostics=list(
eyecatcher="string"
),
display=list(
caseSensitive=TRUE | FALSE,
exclude=TRUE | FALSE,
excludeAll=TRUE | FALSE,
keyIsPath=TRUE | FALSE,
names=list("string-1" <, "string-2", ...>),
pathType="LABEL" | "NAME",
traceNames=TRUE | FALSE
),
exact=TRUE | FALSE,
freq="variable-name",
inputs=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
maxIter=64-bit-integer,
maxMember=64-bit-integer,
maxSteps=64-bit-integer,
minCluster=64-bit-integer,
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(...)>),
nominals=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
outCP=list(
required parameter casOut=list(
caslib="string"
compress=TRUE | FALSE
indexVars=list("variable-name-1" <, "variable-name-2", ...>)
label="string"
lifetime=64-bit-integer
maxMemSize=64-bit-integer
memoryFormat="DVR" | "INHERIT" | "STANDARD"
name="table-name"
promote=TRUE | FALSE
replace=TRUE | FALSE
replication=integer
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"
threadBlockSize=64-bit-integer
timeStamp="string"
where=list("string-1" <, "string-2", ...>)
),
eps=double,
list=TRUE | FALSE
),
outEdge=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
outputTables=list(
groupByVarsRaw=TRUE | FALSE,
includeAll=TRUE | FALSE,
names=list("string-1" <, "string-2", ...>) | list(key-1=list(casouttable-1) <, key-2=list(casouttable-2), ...>),
repeated=TRUE | FALSE,
replace=TRUE | FALSE
),
outTree=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
outVert=list(
caslib="string",
compress=TRUE | FALSE,
indexVars=list("variable-name-1" <, "variable-name-2", ...>),
label="string",
lifetime=64-bit-integer,
maxMemSize=64-bit-integer,
memoryFormat="DVR" | "INHERIT" | "STANDARD",
name="table-name",
promote=TRUE | FALSE,
replace=TRUE | FALSE,
replication=integer,
tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",
threadBlockSize=64-bit-integer,
timeStamp="string",
where=list("string-1" <, "string-2", ...>)
),
polynomial=list( list(
degree=integer,
details=TRUE | FALSE,
labelStyle=list(
expand=TRUE | FALSE
exponent="string"
includeName=TRUE | FALSE
productSymbol="NONE" | "string"
),
mDegree=integer,
required parameter name="string",
noSeparate=TRUE | FALSE,
standardize=list(
method="MOMENTS" | "MRANGE" | "WMOMENTS"
options="CENTER" | "CENTERSCALE" | "NONE" | "SCALE"
prefix="NONE" | "string"
),
required parameter vars=list("variable-name-1" <, "variable-name-2", ...>)
) <, list(...)>),
rho=double,
select="ADJBIC" | "CV" | "NONE" | "PENALIZED",
stop=64-bit-integer,
required parameter table=list(
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
computedVarsProgram="string",
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
groupBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters),
required parameter name="table-name",
orderBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
singlePass=TRUE | FALSE,
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
where="where-expression",
whereTable=list(
casLib="string"
dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
required parameter name="table-name"
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>)
where="where-expression"
)
),
target="string",
weight="variable-name",
xTol=double
)
indicates a required parameter

Summary: Input and Output Tables

If a row includes a subparameter, you can specify the name, caslib, and so on in the subparameter. Otherwise, you can specify the name, caslib, and so on in the parameter.

Parameters for Reading Input Tables

Parameter

Subparameter

Description

required parametertable

specifies the settings for an input table.

Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outCP

required parametercasOut

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

 outEdge

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

 outTree

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

 outVert

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

 outputTables

names

lists the names of results tables to save as CAS tables on the server.

Parameter Descriptions

attributes=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

changes the attributes of variables used in this action. Currently, attributes specified on the inputs and nominals parameter are ignored.

For more information about specifying the attributes parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias attribute

collection=list( list(collection-1) <, list(collection-2), ...>)

defines a set of variables that are treated as a single effect that has multiple degrees of freedom.

The collection value can be one or more of the following:

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.

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

specifies a set of variables that are treated as a single effect that has multiple degrees of freedom. The columns in the design matrix that are contributed by a collection effect are the design columns of its constituent variables in the order in which they appear in the definition of the collection effect.

diagnostics=list(_diagnostics)

eyecatcher="string"

specifies a quoted string that will be prefixed to any messages that are associated with this action invocation.

display=list(displayTables)

specifies a list of results tables to send to the client for display.

For more information about specifying the display parameter, see the common displayTables parameter (Appendix A: Common Parameters).

exact=TRUE | FALSE

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Alias noblock
Default FALSE

freq="variable-name"

names the numeric variable that contains the frequency of occurrence for each observation.

inputs=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies variables to use for analysis.

For more information about specifying the inputs parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias input

maxIter=64-bit-integer

specifies the maximum number of iterations for estimating the sparse precision covariance matrix by using coordinate descent.

Default 50
Range 1–100000

maxMember=64-bit-integer

stops the action when the number of members within any cluster is greater than or equal to the specified value.

Range 1–100000

maxSteps=64-bit-integer

specifies the maximum number of clustering steps.

Default 3
Range 1–50

minCluster=64-bit-integer

stops the action when the number of clusters is less than or equal to the specified value.

Default 3
Range 1–100000

multimember=list( list(multimember-1) <, list(multimember-2), ...>)

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.

For more information about specifying the multimember parameter, see the common multimember parameter (Appendix A: Common Parameters).

nominals=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)

specifies nominal variables to use for analysis.

For more information about specifying the nominals parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).

Alias nominal

outCP=list(OutputCPStatement)

creates a data set that contains a symmetric matrix that depicts the covariances among variables and also creates a set of statistics about the input data set and variables.

The OutputCPStatement value can be one or more of the following:

* casOut=list(casouttable)

specifies the output table.

For more information about specifying the casOut parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

eps=double

specifies an epsilon value such that matrix entries that have an absolute value smaller than epsilon are ignored in the output. You must specify the list parameter when you specify the eps parameter.

Default 0
Minimum value 0
list=TRUE | FALSE

when set to True, outputs the symmetric matrix in the list-of-lists (LIL) format.

Default FALSE

outEdge=list(casouttable)

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the information that defines the edges in the network: _FROM_, _TO_ and _WEIGHT_.

For more information about specifying the outEdge parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outputTables=list(outputTables)

lists the names of results tables to save as CAS tables on the server.

For more information about specifying the outputTables parameter, see the common outputTables parameter (Appendix A: Common Parameters).

Alias displayOut

outTree=list(casouttable)

creates a data set that depicts a tree diagram to display the hierarchical clustering results. The tree diagram can be plotted using the DENDROGRAM statement in the Graph Template Language.

For more information about specifying the outTree parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

outVert=list(casouttable)

creates a data set for use with the Hypergroup action in the tkhypgrp action library. This table contains the vertices in the network and their size.

For more information about specifying the outVert parameter, see the common casouttable (Form 1) parameter (Appendix A: Common Parameters).

polynomial=list( list(polynomial-1) <, list(polynomial-2), ...>)

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.

For more information about specifying the polynomial parameter, see the common polynomial parameter (Appendix A: Common Parameters).

Alias poly

rho=double

specifies the value of rho that determines the sequence of regulation parameters [the first power of rho, the second power of rho, and so on], that are used on sequential clustering steps.

Default 0.8

select="ADJBIC" | "CV" | "NONE" | "PENALIZED"

when set to True, performs graphical variable clustering without preprocessing by thresholding the sample covariance into connected components. By default, the preprocessing step is performed.

Default NONE

stop=64-bit-integer

requests that the action stop if the clustering results do not change in the previous number of consecutive step that is specified in this parameter.

Default 3
Range 2–100

* table=list(castable)

specifies the settings for an input table.

For more information about specifying the table parameter, see the common castable (Form 1) parameter (Appendix A: Common Parameters).

target="string"

specifies the target variable to use for analysis.

weight="variable-name"

names the numeric variable to use to perform a weighted analysis of the data.

xTol=double

specifies the minimal absolute tolerance at which an iteration stops.

Default 0.001
Minimum value 1E-12
Last updated: November 23, 2025