Simple Analytics Action Set: Syntax

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

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

descending=TRUE | FALSE,

groupByLimit=64-bit-integer,

includeMissing=TRUE | FALSE,

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

orderByGbyRaw=TRUE | FALSE,

returnValidSet=TRUE | FALSE,

={{

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

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

where="where-expression"

}, {...}},

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

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

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"

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}

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

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

descending=TRUE | FALSE

when set to True, the formatted levels of the variables are arranged in descending order.

Default	FALSE

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

includeMissing=TRUE | FALSE

when set to True, missing values are included in the determination of group-by values.

Default	TRUE

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

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

returnValidSet=TRUE | FALSE

when set to True, the group-by sets whose sizes do not exceed the specified group-by limit are returned.

Alias	returnValidSets
Default	FALSE

sets={{mdSumset-1} <, {mdSumset-2}, ...>}

specifies the set specifications.

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

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

specifies the list of group-by variables for this set.

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

specifies the formats for the group-by variables.

where="where-expression"

specifies a filter expression for this set specification.

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.

mdSummary Action

Calculates multidimensional summaries of numeric variables.

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
Example:	Calculate Multidimensional Summaries of a Numeric Variable

Lua Syntax

results, info = s:simple_mdSummary{

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

descending=true | false,

groupByLimit=64-bit-integer,

includeMissing=true | false,

={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

orderByGbyRaw=true | false,

returnValidSet=true | false,

={{

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

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

where="where-expression"

}, {...}},

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

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

descending=true | false

when set to True, the formatted levels of the variables are arranged in descending order.

Default	false

groupByLimit=64-bit-integer

Minimum value	1

includeMissing=true | false

when set to True, missing values are included in the determination of group-by values.

Default	true

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

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

returnValidSet=true | false

when set to True, the group-by sets whose sizes do not exceed the specified group-by limit are returned.

Alias	returnValidSets
Default	false

sets={{mdSumset-1} <, {mdSumset-2}, ...>}

specifies the set specifications.

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

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

specifies the list of group-by variables for this set.

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

specifies the formats for the group-by variables.

where="where-expression"

specifies a filter expression for this set specification.

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.

mdSummary Action

Calculates multidimensional summaries of numeric variables.

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
Example:	Calculate Multidimensional Summaries of a Numeric Variable

Python Syntax

results=s.simple.mdSummary(

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

descending=True | False,

groupByLimit=64-bit-integer,

includeMissing=True | False,

=[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

orderByGbyRaw=True | False,

returnValidSet=True | False,

=[{

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

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

"where":"where-expression"

}<, {...}>],

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

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

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

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

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

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

descending=True | False

when set to True, the formatted levels of the variables are arranged in descending order.

Default	False

groupByLimit=64-bit-integer

Minimum value	1

includeMissing=True | False

when set to True, missing values are included in the determination of group-by values.

Default	True

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

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

returnValidSet=True | False

when set to True, the group-by sets whose sizes do not exceed the specified group-by limit are returned.

Alias	returnValidSets
Default	False

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

specifies the set specifications.

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

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

specifies the list of group-by variables for this set.

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

specifies the formats for the group-by variables.

"where":"where-expression"

specifies a filter expression for this set specification.

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.

mdSummary Action

Calculates multidimensional summaries of numeric variables.

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
Example:	Calculate Multidimensional Summaries of a Numeric Variable

R Syntax

results <– cas.simple.mdSummary(s,

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

descending=TRUE | FALSE,

groupByLimit=64-bit-integer,

includeMissing=TRUE | FALSE,

=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

orderByGbyRaw=TRUE | FALSE,

returnValidSet=TRUE | FALSE,

=list( list(

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

groupByFmts=list("string-1" <, "string-2", ...>),

where="where-expression"

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

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