Simple Analytics Action Set: Syntax

simple.correlation <result=results> <status=rc> /

alpha=TRUE | FALSE,

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

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

covariance=TRUE | FALSE,

csscp=TRUE | FALSE,

descriptiveStats=TRUE | FALSE,

caseSensitive=TRUE | FALSE,

exclude=TRUE | FALSE,

excludeAll=TRUE | FALSE,

keyIsPath=TRUE | FALSE,

names={"string-1" <, "string-2", ...>},

pathType="LABEL" | "NAME",

traceNames=TRUE | FALSE

excludeNonPosWgt=TRUE | FALSE,

excludePairStats=TRUE | FALSE,

excludeProbs=TRUE | FALSE,

freq="variable-name",

groupByLimit=64-bit-integer,

casLib="string",

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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},

name="table-name",

where="where-expression"

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

listwiseDelMiss=TRUE | FALSE,

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

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

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

rank=TRUE | FALSE,

sscp=TRUE | FALSE,

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars

={{

format="string",

formattedLength=integer,

label="string",

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

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=TRUE | FALSE,

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable

casLib="string"

name="table-name"

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

topCorrelation=integer,

varInfo=TRUE | FALSE,

weight="variable-name"

;

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
groupbyTable	—	specifies an input table that contains the groups to use in a group-by analysis.
required parametertable	—	Input data table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.
outputTables	names	lists the names of results tables to save as CAS tables on the server.
pearsonOut	—	specifies an output table to contain the requested statistics.

Parameter Descriptions

alpha=TRUE | FALSE

when set to True, computes Cronbach's coefficient alpha.

Default	FALSE

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

specifies the variable attributes.

For more information about specifying the attributes parameter, see the common casinvardesc parameter.

Aliases	attribute
	attrs
	attr
	varAttrs

casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter.

covariance=TRUE | FALSE

when set to True, creates a table of the variance/covariance matrix.

Alias	cov
Default	FALSE

csscp=TRUE | FALSE

when set to True, creates a table of the corrected sum of squares and cross-products.

Default	FALSE

descriptiveStats=TRUE | FALSE

when set to True, univariate descriptive statistics are generated for the analysis variables.

Alias	simple
Default	TRUE

display={displayTables}

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

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

caseSensitive=TRUE | FALSE

when set to True, filtering of the results table names for display is case-sensitive.

Default	FALSE

exclude=TRUE | FALSE

when set to True, suppresses display of the results tables that are specified in the names parameter.

Default	FALSE

excludeAll=TRUE | FALSE

when set to True, suppresses display of all results tables.

Default	FALSE

keyIsPath=TRUE | FALSE

when set to False, the results table key is just the table name. By default, the key is the entire path.

Default	TRUE

names={"string-1" <, "string-2", ...>}

specifies a list of quoted results table names to display on the client.

Requirement	The specified values must be unique.

pathType="LABEL" | "NAME"

specifies whether the path for results table keys consists of group names or group labels.

Default	NAME

traceNames=TRUE | FALSE

when set to True, logs the results table names in the client journal.

Default	FALSE

excludeNonPosWgt=TRUE | FALSE

when set to True, excludes from the analysis observations that have nonpositive weight values.

Alias	exclnpWgt
Default	FALSE

excludePairStats=TRUE | FALSE

when set to True, suppresses the display of statistics associated with pairwise deletion.

Alias	noStatMiss
Default	FALSE

excludeProbs=TRUE | FALSE

when set to True, suppresses the computation of the probabilities that are associated with each correlation coefficient.

Aliases	noProb
Aliases	noProbs
Default	TRUE

freq="variable-name"

specifies a numeric variable that contains the frequency of occurrence of each observation.

groupByLimit=64-bit-integer

specifies the maximum number of levels in a group-by set. When the server determines this number of levels, the server stops and does not return a result. Specify this parameter if you want to avoid creating large result sets in group-by operations.

Minimum value	1

groupbyTable={groupbytable}

specifies an input table that contains the groups to use in a group-by analysis.

Long form	groupbyTable={name="table-name"}
Shortcut form	groupbyTable="table-name"

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the filter table.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

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

specifies the input variables for the analysis.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Aliases	input
	vars
	var

listwiseDelMiss=TRUE | FALSE

when set to True, listwise deletion is applied to observations with missing values.

Alias	noMiss
Default	FALSE

outputTables={outputTables}

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

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

groupByVarsRaw=TRUE | FALSE

when set to True, uses raw instead of formatted group-by values in the CAS table.

Default	TRUE

includeAll=TRUE | FALSE

when set to True, an output CAS table is automatically created for each result table. The name of the created output CAS table is the same as the corresponding result table name. This parameter when set to true takes precedence over the names parameter.

Default	FALSE

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>}

specifies the results tables to save as CAS tables on the server. By default, each created CAS table uses the same name as the results table. To use a different name, specify a casouttable value for the corresponding results table name.

The casouttable value is specified as follows:

caslib="string"

specifies the name of the caslib for the output table.

compress=TRUE | FALSE

when set to True, applies data compression to the table.

Default	FALSE

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

specifies the list of variables to create indexes for in the output data.

label="string"

specifies the descriptive label to associate with the table.

lifetime=64-bit-integer

specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.

Default	0
Minimum value	0

maxMemSize=64-bit-integer

specifies the maximum amount of memory, in bytes, that each thread should allocate for in-memory blocks before converting to a memory-mapped file. Files are written in the directories that are specified in the CAS_DISK_CACHE environment variable.

TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

memoryFormat="DVR" | "INHERIT" | "STANDARD"

specifies the memory format for the output table.

Default	INHERIT

name="table-name"

specifies the name for the output table.

onDemand=TRUE | FALSE

This parameter is deprecated.

Default	TRUE

promote=TRUE | FALSE

when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.

Default	FALSE

replace=TRUE | FALSE

when set to True, overwrites an existing table that has the same name.

Default	FALSE

replication=integer

specifies the number of copies of the table to make for fault tolerance. Larger values result in slower performance and use more memory, but provide high availability for data in the event of a node failure. Data redundancy applies to distributed servers only.

Default	1
Minimum value	0

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"

Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.

threadBlockSize=64-bit-integer

specifies the number of bytes to use for blocks in the output table. The blocks are read by threads. Gradually increase this value when you have a large table with millions or billions of rows and you are tuning for performance. Larger values can increase performance with indexed tables. However, if the value is too large, then you can cause thread starvation due to too few blocks for threads to work on.

Alias	blockSize
Default	1048576
Minimum value	0
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

timeStamp="string"

specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.

where={"string-1" <, "string-2", ...>}

specifies one or more expressions for subsetting the output data. When multiple expressions are specified, the expressions are effectively combined using AND to form the final output filter. If an expression contains quoted values, use nested quotation marks.

repeated=TRUE | FALSE

when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.

Default	FALSE

replace=TRUE | FALSE

when set to True, overwrites an existing CAS table of the same name. This parameter applies to all tables specified in the names parameter unless overridden by the replace parameter in individual casouttable specifications.

Default	TRUE

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

specifies the numeric variables with which correlations of the INPUT parameter variables are to be computed.

For more information about specifying the pairWithInput parameter, see the common casinvardesc parameter.

Alias	with

pearsonOut={casouttable}

specifies an output table to contain the requested statistics.

For more information about specifying the pearsonOut parameter, see the common casouttable parameter.

Aliases	outP
Aliases	outPearson

rank=TRUE | FALSE

when set to True, displays ordered correlation coefficients.

Default	FALSE

sscp=TRUE | FALSE

when set to True, creates a table of the sum of squares and cross-products.

Default	FALSE

* table={castable}

Input data table.

For more information about specifying the table parameter, see the common castable parameter.

topCorrelation=integer

specifies the number of ordered correlation coefficients displayed.

Alias	best
Minimum value	1

varianceDivisor="DF" | "N" | "WDF" | "WEIGHT"

specifies the variance divisor in the calculation of variances and covariances.

Alias	varDef
Default	DF

DF

divides by the degrees of freedom.

N

divides by the number of observations.

WDF

divides by the sum of weights minus one.

WEIGHT

divides by the sum of weights.

varInfo=TRUE | FALSE

when set to True, creates a table of variable information.

Default	FALSE

weight="variable-name"

specifies a numeric variable that is used as a weight in the calculation of Pearson weighted product-moment correlation.

correlation Action

Computes Pearson product-moment correlations..

See:	Results
Example:	Generate a Matrix of Pearson Product-Moment Correlation Coefficients

Lua Syntax

results, info = s:simple_correlation{

alpha=true | false,

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

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

covariance=true | false,

csscp=true | false,

descriptiveStats=true | false,

caseSensitive=true | false,

exclude=true | false,

excludeAll=true | false,

keyIsPath=true | false,

names={"string-1" <, "string-2", ...>},

pathType="LABEL" | "NAME",

traceNames=true | false

excludeNonPosWgt=true | false,

excludePairStats=true | false,

excludeProbs=true | false,

freq="variable-name",

groupByLimit=64-bit-integer,

casLib="string",

name="table-name",

where="where-expression"

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

listwiseDelMiss=true | false,

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

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

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

rank=true | false,

sscp=true | false,

caslib="string",

computedOnDemand=true | false,

computedVars

={{

format="string",

formattedLength=integer,

label="string",

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

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=true | false,

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable

casLib="string"

name="table-name"

vars

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

topCorrelation=integer,

varInfo=true | false,

weight="variable-name"

}

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
groupbyTable	—	specifies an input table that contains the groups to use in a group-by analysis.
required parametertable	—	Input data table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.
outputTables	names	lists the names of results tables to save as CAS tables on the server.
pearsonOut	—	specifies an output table to contain the requested statistics.

Parameter Descriptions

alpha=true | false

when set to True, computes Cronbach's coefficient alpha.

Default	false

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

specifies the variable attributes.

For more information about specifying the attributes parameter, see the common casinvardesc parameter.

Aliases	attribute
	attrs
	attr
	varAttrs

casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter.

covariance=true | false

when set to True, creates a table of the variance/covariance matrix.

Alias	cov
Default	false

csscp=true | false

when set to True, creates a table of the corrected sum of squares and cross-products.

Default	false

descriptiveStats=true | false

when set to True, univariate descriptive statistics are generated for the analysis variables.

Alias	simple
Default	true

display={displayTables}

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

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

caseSensitive=true | false

when set to True, filtering of the results table names for display is case-sensitive.

Default	false

exclude=true | false

when set to True, suppresses display of the results tables that are specified in the names parameter.

Default	false

excludeAll=true | false

when set to True, suppresses display of all results tables.

Default	false

keyIsPath=true | false

when set to False, the results table key is just the table name. By default, the key is the entire path.

Default	true

names={"string-1" <, "string-2", ...>}

specifies a list of quoted results table names to display on the client.

Requirement	The specified values must be unique.

pathType="LABEL" | "NAME"

specifies whether the path for results table keys consists of group names or group labels.

Default	NAME

traceNames=true | false

when set to True, logs the results table names in the client journal.

Default	false

excludeNonPosWgt=true | false

when set to True, excludes from the analysis observations that have nonpositive weight values.

Alias	exclnpWgt
Default	false

excludePairStats=true | false

when set to True, suppresses the display of statistics associated with pairwise deletion.

Alias	noStatMiss
Default	false

excludeProbs=true | false

when set to True, suppresses the computation of the probabilities that are associated with each correlation coefficient.

Aliases	noProb
Aliases	noProbs
Default	true

freq="variable-name"

specifies a numeric variable that contains the frequency of occurrence of each observation.

groupByLimit=64-bit-integer

Minimum value	1

groupbyTable={groupbytable}

specifies an input table that contains the groups to use in a group-by analysis.

Long form	groupbyTable={name="table-name"}
Shortcut form	groupbyTable="table-name"

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

casLib="string"

specifies the caslib for the filter table. By default, the active caslib is used.

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* name="table-name"

specifies the name of the filter table.

where="where-expression"

specifies an expression for subsetting the data from the filter table.

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

specifies the input variables for the analysis.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Aliases	input
	vars
	var

listwiseDelMiss=true | false

when set to True, listwise deletion is applied to observations with missing values.

Alias	noMiss
Default	false

outputTables={outputTables}

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

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

groupByVarsRaw=true | false

when set to True, uses raw instead of formatted group-by values in the CAS table.

Default	true

includeAll=true | false

Default	false

names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>}

The casouttable value is specified as follows:

caslib="string"

specifies the name of the caslib for the output table.

compress=true | false

when set to True, applies data compression to the table.

Default	false

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

specifies the list of variables to create indexes for in the output data.

label="string"

specifies the descriptive label to associate with the table.

lifetime=64-bit-integer

specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.

Default	0
Minimum value	0

maxMemSize=64-bit-integer

TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

memoryFormat="DVR" | "INHERIT" | "STANDARD"

specifies the memory format for the output table.

Default	INHERIT

name="table-name"

specifies the name for the output table.

onDemand=true | false

This parameter is deprecated.

Default	true

promote=true | false

when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.

Default	false

replace=true | false

when set to True, overwrites an existing table that has the same name.

Default	false

replication=integer

Default	1
Minimum value	0

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE"

Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.

threadBlockSize=64-bit-integer

Alias	blockSize
Default	1048576
Minimum value	0
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

timeStamp="string"

specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.

where={"string-1" <, "string-2", ...>}

repeated=true | false

when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.

Default	false

replace=true | false

Default	true

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

specifies the numeric variables with which correlations of the INPUT parameter variables are to be computed.

For more information about specifying the pairWithInput parameter, see the common casinvardesc parameter.

Alias	with

pearsonOut={casouttable}

specifies an output table to contain the requested statistics.

For more information about specifying the pearsonOut parameter, see the common casouttable parameter.

Aliases	outP
Aliases	outPearson

rank=true | false

when set to True, displays ordered correlation coefficients.

Default	false

sscp=true | false

when set to True, creates a table of the sum of squares and cross-products.

Default	false

* table={castable}

Input data table.

For more information about specifying the table parameter, see the common castable parameter.

topCorrelation=integer

specifies the number of ordered correlation coefficients displayed.

Alias	best
Minimum value	1

varianceDivisor="DF" | "N" | "WDF" | "WEIGHT"

specifies the variance divisor in the calculation of variances and covariances.

Alias	varDef
Default	DF

DF

divides by the degrees of freedom.

N

divides by the number of observations.

WDF

divides by the sum of weights minus one.

WEIGHT

divides by the sum of weights.

varInfo=true | false

when set to True, creates a table of variable information.

Default	false

weight="variable-name"

specifies a numeric variable that is used as a weight in the calculation of Pearson weighted product-moment correlation.

correlation Action

Computes Pearson product-moment correlations..

See:	Results
Example:	Generate a Matrix of Pearson Product-Moment Correlation Coefficients

Python Syntax

results=s.simple.correlation(

alpha=True | False,

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

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

covariance=True | False,

csscp=True | False,

descriptiveStats=True | False,

"caseSensitive":True | False,

"exclude":True | False,

"excludeAll":True | False,

"keyIsPath":True | False,

"names":["string-1" <, "string-2", ...>],

"pathType":"LABEL" | "NAME",

"traceNames":True | False

excludeNonPosWgt=True | False,

excludePairStats=True | False,

excludeProbs=True | False,

freq="variable-name",

groupByLimit=64-bit-integer,

"casLib":"string",

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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},

"name":"table-name",

"where":"where-expression"

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

listwiseDelMiss=True | False,

"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

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

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

rank=True | False,

sscp=True | False,

"caslib":"string",

"computedOnDemand":True | False,

"computedVars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

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

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"groupByMode":"NOSORT" | "REDISTRIBUTE",

"name":"table-name",

"orderBy"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"singlePass":True | False,

"vars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"whereTable"

"casLib":"string"

"name":"table-name"

"vars"

:[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

topCorrelation=integer,

varInfo=True | False,

weight="variable-name"

)

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
groupbyTable	—	specifies an input table that contains the groups to use in a group-by analysis.
required parametertable	—	Input data table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.
outputTables	names	lists the names of results tables to save as CAS tables on the server.
pearsonOut	—	specifies an output table to contain the requested statistics.

Parameter Descriptions

alpha=True | False

when set to True, computes Cronbach's coefficient alpha.

Default	False

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

specifies the variable attributes.

For more information about specifying the attributes parameter, see the common casinvardesc parameter.

Aliases	attribute
	attrs
	attr
	varAttrs

casOut={casouttable}

specifies the settings for an output table.

For more information about specifying the casOut parameter, see the common casouttable parameter.

covariance=True | False

when set to True, creates a table of the variance/covariance matrix.

Alias	cov
Default	False

csscp=True | False

when set to True, creates a table of the corrected sum of squares and cross-products.

Default	False

descriptiveStats=True | False

when set to True, univariate descriptive statistics are generated for the analysis variables.

Alias	simple
Default	True

display={displayTables}

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

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

"caseSensitive":True | False

when set to True, filtering of the results table names for display is case-sensitive.

Default	False

"exclude":True | False

when set to True, suppresses display of the results tables that are specified in the names parameter.

Default	False

"excludeAll":True | False

when set to True, suppresses display of all results tables.

Default	False

"keyIsPath":True | False

when set to False, the results table key is just the table name. By default, the key is the entire path.

Default	True

"names":["string-1" <, "string-2", ...>]

specifies a list of quoted results table names to display on the client.

Requirement	The specified values must be unique.

"pathType":"LABEL" | "NAME"

specifies whether the path for results table keys consists of group names or group labels.

Default	NAME

"traceNames":True | False

when set to True, logs the results table names in the client journal.

Default	False

excludeNonPosWgt=True | False

when set to True, excludes from the analysis observations that have nonpositive weight values.

Alias	exclnpWgt
Default	False

excludePairStats=True | False

when set to True, suppresses the display of statistics associated with pairwise deletion.

Alias	noStatMiss
Default	False

excludeProbs=True | False

when set to True, suppresses the computation of the probabilities that are associated with each correlation coefficient.

Aliases	noProb
Aliases	noProbs
Default	True

freq="variable-name"

specifies a numeric variable that contains the frequency of occurrence of each observation.

groupByLimit=64-bit-integer

Minimum value	1

groupbyTable={groupbytable}

specifies an input table that contains the groups to use in a group-by analysis.

Long form	groupbyTable={"name":"table-name"}
Shortcut form	groupbyTable="table-name"

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

"casLib":"string"

specifies the caslib for the filter table. By default, the active caslib is used.

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | duckdb-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}

specifies data source options.

Aliases	options
Aliases	dataSource

For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

specifies the settings for reading a table from a data source.

Alias	import_

For more information about specifying the importOptions parameter, see the common importOptions parameter.

* "name":"table-name"

specifies the name of the filter table.

"where":"where-expression"

specifies an expression for subsetting the data from the filter table.

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

specifies the input variables for the analysis.

For more information about specifying the inputs parameter, see the common casinvardesc parameter.

Aliases	input
	vars
	var

listwiseDelMiss=True | False

when set to True, listwise deletion is applied to observations with missing values.

Alias	noMiss
Default	False

outputTables={outputTables}

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

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

"groupByVarsRaw":True | False

when set to True, uses raw instead of formatted group-by values in the CAS table.

Default	True

"includeAll":True | False

Default	False

"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>}

The casouttable value is specified as follows:

"caslib":"string"

specifies the name of the caslib for the output table.

"compress":True | False

when set to True, applies data compression to the table.

Default	False

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

specifies the list of variables to create indexes for in the output data.

"label":"string"

specifies the descriptive label to associate with the table.

"lifetime":64-bit-integer

specifies the number of seconds to keep the table in memory after it is last accessed. The table is dropped if it is not accessed for the specified number of seconds.

Default	0
Minimum value	0

"maxMemSize":64-bit-integer

TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

"memoryFormat":"DVR" | "INHERIT" | "STANDARD"

specifies the memory format for the output table.

Default	INHERIT

"name":"table-name"

specifies the name for the output table.

"onDemand":True | False

This parameter is deprecated.

Default	True

"promote":True | False

when set to True, adds the output table with a global scope. This enables other sessions to access the table, subject to access controls. The target caslib must also have a global scope.

Default	False

"replace":True | False

when set to True, overwrites an existing table that has the same name.

Default	False

"replication":integer

Default	1
Minimum value	0

"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE"

Specifies the Table Redistribution Policy when the number of worker pods increases on a running CAS server.

"threadBlockSize":64-bit-integer

Alias	blockSize
Default	1048576
Minimum value	0
TIP	You can enclose the value in quotation marks and specify B, K, M, G, or T as a suffix to indicate the units. For example, "8M" specifies eight megabytes.

"timeStamp":"string"

specifies to add a timestamp column to the table. Support for timeStamp is action-specific. Specify the value in the form that is appropriate for your session locale.

"where":["string-1" <, "string-2", ...>]

"repeated":True | False

when set to True, replicates CAS tables on all nodes. This parameter applies to all tables.

Default	False

"replace":True | False

Default	True

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

specifies the numeric variables with which correlations of the INPUT parameter variables are to be computed.

For more information about specifying the pairWithInput parameter, see the common casinvardesc parameter.

Alias	with_

pearsonOut={casouttable}

specifies an output table to contain the requested statistics.

For more information about specifying the pearsonOut parameter, see the common casouttable parameter.

Aliases	outP
Aliases	outPearson

rank=True | False

when set to True, displays ordered correlation coefficients.

Default	False

sscp=True | False

when set to True, creates a table of the sum of squares and cross-products.

Default	False

* table={castable}

Input data table.

For more information about specifying the table parameter, see the common castable parameter.

topCorrelation=integer

specifies the number of ordered correlation coefficients displayed.

Alias	best
Minimum value	1

varianceDivisor="DF" | "N" | "WDF" | "WEIGHT"

specifies the variance divisor in the calculation of variances and covariances.

Alias	varDef
Default	DF

DF

divides by the degrees of freedom.

N

divides by the number of observations.

WDF

divides by the sum of weights minus one.

WEIGHT

divides by the sum of weights.

varInfo=True | False

when set to True, creates a table of variable information.

Default	False

weight="variable-name"

specifies a numeric variable that is used as a weight in the calculation of Pearson weighted product-moment correlation.

correlation Action

Computes Pearson product-moment correlations..

See:	Results
Example:	Generate a Matrix of Pearson Product-Moment Correlation Coefficients

R Syntax

results <– cas.simple.correlation(s,

alpha=TRUE | FALSE,

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

=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", ...>)

covariance=TRUE | FALSE,

csscp=TRUE | FALSE,

descriptiveStats=TRUE | FALSE,

=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

excludeNonPosWgt=TRUE | FALSE,

excludePairStats=TRUE | FALSE,

excludeProbs=TRUE | FALSE,

freq="variable-name",

groupByLimit=64-bit-integer,

=list(

casLib="string",

name="table-name",

where="where-expression"

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

listwiseDelMiss=TRUE | FALSE,

=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

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

=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", ...>)

rank=TRUE | FALSE,

sscp=TRUE | FALSE,

=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars

=list( list(

format="string",

formattedLength=integer,

label="string",

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

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

singlePass=TRUE | FALSE,

vars

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>),

where="where-expression",

whereTable

=list(

casLib="string"

name="table-name"

vars

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

topCorrelation=integer,