Simple Analytics Action Set: Syntax

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

={{

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

ciAlpha=double,

ciType="LOWER" | "RIGHT" | "TWOSIDED",

freq="variable-name",

groupByLimit=64-bit-integer,

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

name="table-name",

where="where-expression"

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

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

orderByAgg={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"},

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

orderByGbyRaw=TRUE | FALSE,

repeat=TRUE | FALSE,

resultLimit=integer,

sql=TRUE | FALSE,

subSet={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"},

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"

}

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	—	specifies the table name, caslib, and other common parameters.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.

Parameter Descriptions

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.

ciAlpha=double

specifies the level of significance for 100*(1-ciAlpha)% confidence intervals. The default value of 0.05 results in 95% confidence intervals.

Default	0.05
Range	(0, 1)

ciType="LOWER" | "RIGHT" | "TWOSIDED"

specifies the type of confidence interval.

freq="variable-name"

specifies a frequency variable.

Alias	frequency

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

Alias	input

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

specifies one or more variables by which the group values in the result set are to be sorted. The group values are sorted in ascending order of the specified variable values. If the defined orderBy variable appears in both the input and groupBy parameters, the input parameter takes precedence as the sorting criterion.

Restriction	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Requirement	You must specify parameter groupBy in the table parameter. Otherwise, orderBy is ignored.

orderByAgg={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"}

specifies the aggregator on which the ordering of the result set is based if orderBy is specified.

Restriction	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Requirement	For orderByAgg to have any effect, you must also specify parameter groupBy in the table parameter and parameter orderBy.

CSS

specifies the corrected sum of squares.

CV

specifies the coefficient of variation.

KURTOSIS

specifies the kurtosis.

MAX

specifies the maximum value.

MEAN

specifies the arithmetic mean.

MIN

specifies the minimum value.

N

specifies the number of observations.

NMISS

specifies the number of missing values.

PROBT

specifies the p-value for the t-statistic.

SKEWNESS

specifies the skewness.

STD

specifies the standard deviation.

STDERR

specifies the standard error.

SUM

specifies the sum of nonmissing values.

TSTAT

specifies the t-statistic for H:mean=0.

Alias	T

USS

specifies the uncorrected sum of squares.

VAR

specifies the sample variance.

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

specifies one or more variables by which the group values in the result set are to be sorted. The group values are sorted in descending order of the specified variable values.

Restrictions	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Restrictions	For orderByDesc to have any effect, you must also specify parameter orderBy.
Requirement	You must specify one more of the variables that are specified in orderBy in the order in which they are specified in orderBy. For example, to sort the group values in ascending order of variables Origin and Type and descending order of variable Cylinders, specify the following: `orderBy={"cylinders", "origin", "type"}, orderByDesc={"cylinders"}`
See	Get the Distinct Value Count for Multiple Variables

orderByGbyRaw=TRUE | FALSE

when set to True, the ordering of the group-by variables is based on the raw values of the variables, not the formatted values.

Alias	orderByRaw
Default	FALSE

repeat=TRUE | FALSE

when set to True, the action is repeated.

Default	FALSE

resultLimit=integer

specifies the maximum size of the result set returned to the client.

Alias	limit
Range	0–MACINT

sql=TRUE | FALSE

when set to True, the program directly executes SQL queries to retrieve the calculation results.

Default	FALSE

subSet={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"}

specifies the summary statistics to generate.

Aliases	summarySubset
Aliases	statistics
Requirement	The specified values must be unique.

CSS

specifies the corrected sum of squares.

CV

specifies the coefficient of variation.

KURTOSIS

specifies the kurtosis.

MAX

specifies the maximum value.

MEAN

specifies the arithmetic mean.

MIN

specifies the minimum value.

N

specifies the number of observations.

NMISS

specifies the number of missing values.

PROBT

specifies the p-value for the t-statistic.

SKEWNESS

specifies the skewness.

STD

specifies the standard deviation.

STDERR

specifies the standard error.

SUM

specifies the sum of nonmissing values.

TSTAT

specifies the t-statistic for H:mean=0.

Alias	T

USS

specifies the uncorrected sum of squares.

VAR

specifies the sample variance.

* table={castable}

specifies the table name, caslib, and other common parameters.

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

weight="variable-name"

specifies a numeric variable whose values weight the values of the analysis variables.

summary Action

Generates descriptive statistics of numeric variables such as the sample mean, sample variance, sample size, sum of squares, and so on.

Requirement:	The input data must contain at least one numeric variable. Otherwise, this action returns an error for status and an empty dictionary for result.
See:	Results
Examples:	Summarize a Numeric Variable by a Group Variable
Examples:	Summarize a Numeric Variable Using a GroupBy Table

Lua Syntax

results, info = s:simple_summary{

={{

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

ciAlpha=double,

ciType="LOWER" | "RIGHT" | "TWOSIDED",

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

}, {...}},

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

orderByAgg={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"},

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

orderByGbyRaw=true | false,

repeat=true | false,

resultLimit=integer,

sql=true | false,

subSet={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"},

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"

}

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	—	specifies the table name, caslib, and other common parameters.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.

Parameter Descriptions

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.

ciAlpha=double

specifies the level of significance for 100*(1-ciAlpha)% confidence intervals. The default value of 0.05 results in 95% confidence intervals.

Default	0.05
Range	(0, 1)

ciType="LOWER" | "RIGHT" | "TWOSIDED"

specifies the type of confidence interval.

freq="variable-name"

specifies a frequency variable.

Alias	frequency

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

Alias	input

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

Restriction	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Requirement	You must specify parameter groupBy in the table parameter. Otherwise, orderBy is ignored.

orderByAgg={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"}

specifies the aggregator on which the ordering of the result set is based if orderBy is specified.

Restriction	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Requirement	For orderByAgg to have any effect, you must also specify parameter groupBy in the table parameter and parameter orderBy.

CSS

specifies the corrected sum of squares.

CV

specifies the coefficient of variation.

KURTOSIS

specifies the kurtosis.

MAX

specifies the maximum value.

MEAN

specifies the arithmetic mean.

MIN

specifies the minimum value.

N

specifies the number of observations.

NMISS

specifies the number of missing values.

PROBT

specifies the p-value for the t-statistic.

SKEWNESS

specifies the skewness.

STD

specifies the standard deviation.

STDERR

specifies the standard error.

SUM

specifies the sum of nonmissing values.

TSTAT

specifies the t-statistic for H:mean=0.

Alias	T

USS

specifies the uncorrected sum of squares.

VAR

specifies the sample variance.

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

specifies one or more variables by which the group values in the result set are to be sorted. The group values are sorted in descending order of the specified variable values.

Restrictions	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Restrictions	For orderByDesc to have any effect, you must also specify parameter orderBy.
Requirement	You must specify one more of the variables that are specified in orderBy in the order in which they are specified in orderBy. For example, to sort the group values in ascending order of variables Origin and Type and descending order of variable Cylinders, specify the following: `orderBy={"cylinders", "origin", "type"}, orderByDesc={"cylinders"}`
See	Get the Distinct Value Count for Multiple Variables

orderByGbyRaw=true | false

when set to True, the ordering of the group-by variables is based on the raw values of the variables, not the formatted values.

Alias	orderByRaw
Default	false

repeat=true | false

when set to True, the action is repeated.

Default	false

resultLimit=integer

specifies the maximum size of the result set returned to the client.

Alias	limit
Range	0–MACINT

sql=true | false

when set to True, the program directly executes SQL queries to retrieve the calculation results.

Default	false

subSet={"CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"}

specifies the summary statistics to generate.

Aliases	summarySubset
Aliases	statistics
Requirement	The specified values must be unique.

CSS

specifies the corrected sum of squares.

CV

specifies the coefficient of variation.

KURTOSIS

specifies the kurtosis.

MAX

specifies the maximum value.

MEAN

specifies the arithmetic mean.

MIN

specifies the minimum value.

N

specifies the number of observations.

NMISS

specifies the number of missing values.

PROBT

specifies the p-value for the t-statistic.

SKEWNESS

specifies the skewness.

STD

specifies the standard deviation.

STDERR

specifies the standard error.

SUM

specifies the sum of nonmissing values.

TSTAT

specifies the t-statistic for H:mean=0.

Alias	T

USS

specifies the uncorrected sum of squares.

VAR

specifies the sample variance.

* table={castable}

specifies the table name, caslib, and other common parameters.

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

weight="variable-name"

specifies a numeric variable whose values weight the values of the analysis variables.

summary Action

Generates descriptive statistics of numeric variables such as the sample mean, sample variance, sample size, sum of squares, and so on.

Requirement:	The input data must contain at least one numeric variable. Otherwise, this action returns an error for status and an empty dictionary for result.
See:	Results
Examples:	Summarize a Numeric Variable by a Group Variable
Examples:	Summarize a Numeric Variable Using a GroupBy Table

Python Syntax

results=s.simple.summary(

=[{

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

ciAlpha=double,

ciType="LOWER" | "RIGHT" | "TWOSIDED",

freq="variable-name",

groupByLimit=64-bit-integer,

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

"name":"table-name",

"where":"where-expression"

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

orderBy=["variable-name-1" <, "variable-name-2", ...>],

orderByAgg=["CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"],

orderByDesc=["variable-name-1" <, "variable-name-2", ...>],

orderByGbyRaw=True | False,

repeat=True | False,

resultLimit=integer,

sql=True | False,

subSet=["CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"],

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

}

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	—	specifies the table name, caslib, and other common parameters.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
casOut	—	specifies the settings for an output table.

Parameter Descriptions

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.

ciAlpha=double

specifies the level of significance for 100*(1-ciAlpha)% confidence intervals. The default value of 0.05 results in 95% confidence intervals.

Default	0.05
Range	(0, 1)

ciType="LOWER" | "RIGHT" | "TWOSIDED"

specifies the type of confidence interval.

freq="variable-name"

specifies a frequency variable.

Alias	frequency

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

Alias	input

orderBy=["variable-name-1" <, "variable-name-2", ...>]

Restriction	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Requirement	You must specify parameter groupBy in the table parameter. Otherwise, orderBy is ignored.

orderByAgg=["CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"]

specifies the aggregator on which the ordering of the result set is based if orderBy is specified.

Restriction	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Requirement	For orderByAgg to have any effect, you must also specify parameter groupBy in the table parameter and parameter orderBy.

CSS

specifies the corrected sum of squares.

CV

specifies the coefficient of variation.

KURTOSIS

specifies the kurtosis.

MAX

specifies the maximum value.

MEAN

specifies the arithmetic mean.

MIN

specifies the minimum value.

N

specifies the number of observations.

NMISS

specifies the number of missing values.

PROBT

specifies the p-value for the t-statistic.

SKEWNESS

specifies the skewness.

STD

specifies the standard deviation.

STDERR

specifies the standard error.

SUM

specifies the sum of nonmissing values.

TSTAT

specifies the t-statistic for H:mean=0.

Alias	T

USS

specifies the uncorrected sum of squares.

VAR

specifies the sample variance.

orderByDesc=["variable-name-1" <, "variable-name-2", ...>]

specifies one or more variables by which the group values in the result set are to be sorted. The group values are sorted in descending order of the specified variable values.

Restrictions	This parameter affects result tables only. It has no effect when parameter CASOUT= is used to store the results in a caslib.
Restrictions	For orderByDesc to have any effect, you must also specify parameter orderBy.
Requirement	You must specify one more of the variables that are specified in orderBy in the order in which they are specified in orderBy. For example, to sort the group values in ascending order of variables Origin and Type and descending order of variable Cylinders, specify the following: `orderBy={"cylinders", "origin", "type"}, orderByDesc={"cylinders"}`
See	Get the Distinct Value Count for Multiple Variables

orderByGbyRaw=True | False

when set to True, the ordering of the group-by variables is based on the raw values of the variables, not the formatted values.

Alias	orderByRaw
Default	False

repeat=True | False

when set to True, the action is repeated.

Default	False

resultLimit=integer

specifies the maximum size of the result set returned to the client.

Alias	limit
Range	0–MACINT

sql=True | False

when set to True, the program directly executes SQL queries to retrieve the calculation results.

Default	False

subSet=["CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"]

specifies the summary statistics to generate.

Aliases	summarySubset
Aliases	statistics
Requirement	The specified values must be unique.

CSS

specifies the corrected sum of squares.

CV

specifies the coefficient of variation.

KURTOSIS

specifies the kurtosis.

MAX

specifies the maximum value.

MEAN

specifies the arithmetic mean.

MIN

specifies the minimum value.

N

specifies the number of observations.

NMISS

specifies the number of missing values.

PROBT

specifies the p-value for the t-statistic.

SKEWNESS

specifies the skewness.

STD

specifies the standard deviation.

STDERR

specifies the standard error.

SUM

specifies the sum of nonmissing values.

TSTAT

specifies the t-statistic for H:mean=0.

Alias	T

USS

specifies the uncorrected sum of squares.

VAR

specifies the sample variance.

* table={castable}

specifies the table name, caslib, and other common parameters.

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

weight="variable-name"

specifies a numeric variable whose values weight the values of the analysis variables.

summary Action

Generates descriptive statistics of numeric variables such as the sample mean, sample variance, sample size, sum of squares, and so on.

Requirement:	The input data must contain at least one numeric variable. Otherwise, this action returns an error for status and an empty dictionary for result.
See:	Results
Examples:	Summarize a Numeric Variable by a Group Variable
Examples:	Summarize a Numeric Variable Using a GroupBy Table

R Syntax

results <– cas.simple.summary(s,

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

ciAlpha=double,

ciType="LOWER" | "RIGHT" | "TWOSIDED",

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(...)>),

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

orderByAgg=list("CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"),

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

orderByGbyRaw=TRUE | FALSE,

repeat=TRUE | FALSE,

resultLimit=integer,

sql=TRUE | FALSE,

subSet=list("CSS", "CV", "KURTOSIS", "MAX", "MEAN", "MIN", "N", "NMISS", "PROBT", "SKEWNESS", "STD", "STDERR", "SUM", "T", "TSTAT", "USS", "VAR"),