Simple Analytics Action Set: Syntax
Provides actions for performing basic analytic functions
distinct Action
Computes the distinct number of values of the variables in the variable list.
| See: | Results |
|---|---|
| Example: | Get the Distinct Value Count for Multiple Variables |
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
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. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
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.
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 |
|---|---|
| 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.
includeMissing=TRUE | FALSE
when set to True, missing values are included in the determination of distinct 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 |
|---|
maxNVals=64-bit-integer
specifies the largest number of distinct values on any variable in the variable list.
| Minimum value | 1 |
|---|
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.
| 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={"NDIST", "NMISS", "TRUNC"}
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. |
NDIST
specifies the number of distinct values.
NMISS
specifies the number of missing values.
TRUNC
specifies the number of truncated values.
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. |
|---|---|
| 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, when using CASL, to sort the group values in ascending order of variables
Origin and Type and descending order of variable Cylinders, specify the
following:
|
| 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 |
raw=TRUE | FALSE
when set to True, the raw values are used for the variables.
| Default | FALSE |
|---|
resultLimit=integer
limits the number of items in the result set that is returned to the client. The limit is the product of the specified value and the number of analysis variables when groupBy or orderBy is specified.
| 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 |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
For more information about specifying the table parameter, see the common castable parameter.
distinct Action
Computes the distinct number of values of the variables in the variable list.
| See: | Results |
|---|---|
| Example: | Get the Distinct Value Count for Multiple Variables |
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
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. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
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.
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 |
|---|---|
| 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.
includeMissing=true | false
when set to True, missing values are included in the determination of distinct 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 |
|---|
maxNVals=64-bit-integer
specifies the largest number of distinct values on any variable in the variable list.
| Minimum value | 1 |
|---|
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.
| 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={"NDIST", "NMISS", "TRUNC"}
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. |
NDIST
specifies the number of distinct values.
NMISS
specifies the number of missing values.
TRUNC
specifies the number of truncated values.
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. |
|---|---|
| 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, when using CASL, to sort the group values in ascending order of variables
Origin and Type and descending order of variable Cylinders, specify the
following:
|
| 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 |
raw=true | false
when set to True, the raw values are used for the variables.
| Default | false |
|---|
resultLimit=integer
limits the number of items in the result set that is returned to the client. The limit is the product of the specified value and the number of analysis variables when groupBy or orderBy is specified.
| 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 |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
For more information about specifying the table parameter, see the common castable parameter.
distinct Action
Computes the distinct number of values of the variables in the variable list.
| See: | Results |
|---|---|
| Example: | Get the Distinct Value Count for Multiple Variables |
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
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. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
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.
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 |
|---|---|
| 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.
includeMissing=True | False
when set to True, missing values are included in the determination of distinct 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 |
|---|
maxNVals=64-bit-integer
specifies the largest number of distinct values on any variable in the variable list.
| Minimum value | 1 |
|---|
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.
| 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=["NDIST", "NMISS", "TRUNC"]
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. |
NDIST
specifies the number of distinct values.
NMISS
specifies the number of missing values.
TRUNC
specifies the number of truncated values.
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. |
|---|---|
| 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, when using CASL, to sort the group values in ascending order of variables
Origin and Type and descending order of variable Cylinders, specify the
following:
|
| 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 |
raw=True | False
when set to True, the raw values are used for the variables.
| Default | False |
|---|
resultLimit=integer
limits the number of items in the result set that is returned to the client. The limit is the product of the specified value and the number of analysis variables when groupBy or orderBy is specified.
| 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 |
|---|
* table={castable}
specifies the table name, caslib, and other common parameters.
For more information about specifying the table parameter, see the common castable parameter.
distinct Action
Computes the distinct number of values of the variables in the variable list.
| See: | Results |
|---|---|
| Example: | Get the Distinct Value Count for Multiple Variables |
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.
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
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. |
|
Parameter |
Subparameter |
Description |
|---|---|---|
|
— |
specifies the settings for an output table. |
Parameter Descriptions
attributes=list( list(casinvardesc-1) <, list(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=list(casouttable)
specifies the settings for an output table.
For more information about specifying the casOut parameter, see the common casouttable parameter.
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=list(groupbytable)
specifies an input table that contains the groups to use in a group-by analysis.
| Long form | groupbyTable=list(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=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)
specifies data source options.
| Aliases | options |
|---|---|
| dataSource |
For more information about specifying the dataSourceOptions parameter, see the common dataSourceOptions parameter.
importOptions=list(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.
includeMissing=TRUE | FALSE
when set to True, missing values are included in the determination of distinct values.
| Default | TRUE |
|---|
inputs=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the input variables for the analysis.
For more information about specifying the inputs parameter, see the common casinvardesc parameter.
| Alias | input |
|---|
maxNVals=64-bit-integer
specifies the largest number of distinct values on any variable in the variable list.
| Minimum value | 1 |
|---|
orderBy=list("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.
| 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=list("NDIST", "NMISS", "TRUNC")
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. |
NDIST
specifies the number of distinct values.
NMISS
specifies the number of missing values.
TRUNC
specifies the number of truncated values.
orderByDesc=list("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. |
|---|---|
| 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, when using CASL, to sort the group values in ascending order of variables
Origin and Type and descending order of variable Cylinders, specify the
following:
|
| 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 |
raw=TRUE | FALSE
when set to True, the raw values are used for the variables.
| Default | FALSE |
|---|
resultLimit=integer
limits the number of items in the result set that is returned to the client. The limit is the product of the specified value and the number of analysis variables when groupBy or orderBy is specified.
| 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 |
|---|
* table=list(castable)
specifies the table name, caslib, and other common parameters.
For more information about specifying the table parameter, see the common castable parameter.