Frequency and Crosstabulation Analysis Action Set

Provides actions for performing frequency and crosstabulation analysis

freqTab Action

Constructs the frequency and crosstabulation tables.

CASL Syntax

freqTab.freqTab <result=results> <status=rc> /
attributes={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
descending=TRUE | FALSE,
display={
caseSensitive=TRUE | FALSE,
exclude=TRUE | FALSE,
excludeAll=TRUE | FALSE,
keyIsPath=TRUE | FALSE,
names={"string-1" <, "string-2", ...>},
pathType="LABEL" | "NAME",
traceNames=TRUE | FALSE
},
groupByLimit=64-bit-integer,
includeMissing=TRUE | FALSE,
includeZeroWeight=TRUE | FALSE,
nLevelsPrint=integer,
order="FORMATTED" | "FREQ" | "INTERNAL",
outputTables={
groupByVarsRaw=TRUE | FALSE,
includeAll=TRUE | FALSE,
names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},
repeated=TRUE | FALSE,
replace=TRUE | FALSE
},
printLevels=TRUE | FALSE,
tabDisplay={
format="CROSSLIST" | "LIST",
maxLevels=integer,
missingFreq=TRUE | FALSE
},
required parameter table={
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=TRUE | FALSE,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
tabulate={{
cross={"variable-name-1" <, "variable-name-2", ...>},
required parameter vars={"variable-name-1" <, "variable-name-2", ...>}
}, {...}},
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

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outputTables

names

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

Parameter Descriptions

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

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

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

Aliases attribute
attr

descending=TRUE | FALSE

when set to True, reverses the sort order that is imposed by the order parameter.

Default FALSE

display={displayTables}

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

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

groupByLimit=64-bit-integer

suppresses analysis if the number of BY groups exceeds the specified value.

Minimum value 1

includeMissing=TRUE | FALSE

when set to True, treats missing values as valid levels for the variables that are defined in the tabulate parameter.

Default FALSE

includeZeroWeight=TRUE | FALSE

when set to True, includes observations that have weights of 0 in the analysis.

Default FALSE

nLevelsPrint=integer

specifies the maximum number of variable levels to display in the variable level information table. The value 0 suppresses all levels.

Minimum value 0

order="FORMATTED" | "FREQ" | "INTERNAL"

specifies the sort order for the levels of the variables that are defined in the tabulate parameter.

Default INTERNAL
FORMATTED

uses external formatted value, except for numeric variables that have no explicit format, which are sorted by their unformatted (internal) value.

FREQ

uses descending frequency count (levels that have more observations come earlier in the order).

INTERNAL

uses unformatted value.

outputTables={outputTables}

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

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

Alias displayOut

printLevels=TRUE | FALSE

when set to True, displays the variable level information table.

Default TRUE

tabDisplay={freqTab_tabDisplay}

specifies options to control displayed frequency and crosstabulation tables.

Long form tabDisplay={format="CROSSLIST" | "LIST"}
Shortcut form tabDisplay="CROSSLIST" | "LIST"

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

format="CROSSLIST" | "LIST"

specifies the format for displaying two-way and multiway crosstabulation tables.

Default CROSSLIST
CROSSLIST

uses CROSSLIST format, where a separate two-way crosstabulation table is generated for each stratum of a multiway table.

LIST

uses LIST format, where the entire multiway crosstabulation is presented in a single table.

maxLevels=integer

specifies the maximum number of variable levels to display in one-way frequency tables. A value of 0 means an unlimited number of levels.

Default 0
Minimum value 0
missingFreq=TRUE | FALSE

when set to True, displays missing value frequencies in one-way frequency tables and crosstabulation tables in LIST format but does not include the missing value frequencies in any computations of percentages or statistics.

Default FALSE

* table={castable}

specifies the settings for an input table.

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

tabulate={{freqTab_tabulate-1} <, {freqTab_tabulate-2}, ...>}

specifies the frequency and crosstabulation tables to produce. If you specify the vars parameter only, the frequency or crosstabulation table to produce is made up of variables that you specify in the vars parameter. If you specify the cross parameter along with the vars parameter, each pair of variables (one from the vars parameter and the other from the cross parameter, in this order) defines a two-way crosstabulation table to produce. If you omit the tabulate parameter, one-way frequency tables are generated for all variables that are not specified in other parameters.

Alias crossTabs

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

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

specifies the variables to pair with those specified in the vars parameter to produce two-way crosstabulation tables. Each pair of variables, one from the vars parameter and the other from the cross parameter, in this order, defines a two-way crosstabulation table to produce.

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

specifies the variables to use to produce a frequency or crosstabulation table. To produce a one-way frequency table, specify a single variable. To produce a two-way or multiway crosstabulation table (an n-way table, where n>1), specify at least two variables. For a two-way or multiway table, the values of the last specified variable form the crosstabulation table columns, the values of the next-to-last variable form the rows, and each combination of levels of the other variables forms one stratum.

weight="variable-name"

specifies a numeric variable that provides a weight for each observation in the input data table.

freqTab Action

Constructs the frequency and crosstabulation tables.

Lua Syntax

results, info = s:freqTab_freqTab{
attributes={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
descending=true | false,
display={
caseSensitive=true | false,
exclude=true | false,
excludeAll=true | false,
keyIsPath=true | false,
names={"string-1" <, "string-2", ...>},
pathType="LABEL" | "NAME",
traceNames=true | false
},
groupByLimit=64-bit-integer,
includeMissing=true | false,
includeZeroWeight=true | false,
nLevelsPrint=integer,
order="FORMATTED" | "FREQ" | "INTERNAL",
outputTables={
groupByVarsRaw=true | false,
includeAll=true | false,
names={"string-1" <, "string-2", ...>} | {key-1={casouttable-1} <, key-2={casouttable-2}, ...>},
repeated=true | false,
replace=true | false
},
printLevels=true | false,
tabDisplay={
format="CROSSLIST" | "LIST",
maxLevels=integer,
missingFreq=true | false
},
required parameter table={
caslib="string",
computedOnDemand=true | false,
computedVars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
computedVarsProgram="string",
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},
groupBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter name="table-name",
orderBy={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
singlePass=true | false,
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}},
where="where-expression",
whereTable={
casLib="string"
dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter name="table-name"
vars={{
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
}, {...}}
where="where-expression"
}
},
tabulate={{
cross={"variable-name-1" <, "variable-name-2", ...>},
required parameter vars={"variable-name-1" <, "variable-name-2", ...>}
}, {...}},
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

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outputTables

names

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

Parameter Descriptions

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

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

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

Aliases attribute
attr

descending=true | false

when set to True, reverses the sort order that is imposed by the order parameter.

Default false

display={displayTables}

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

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

groupByLimit=64-bit-integer

suppresses analysis if the number of BY groups exceeds the specified value.

Minimum value 1

includeMissing=true | false

when set to True, treats missing values as valid levels for the variables that are defined in the tabulate parameter.

Default false

includeZeroWeight=true | false

when set to True, includes observations that have weights of 0 in the analysis.

Default false

nLevelsPrint=integer

specifies the maximum number of variable levels to display in the variable level information table. The value 0 suppresses all levels.

Minimum value 0

order="FORMATTED" | "FREQ" | "INTERNAL"

specifies the sort order for the levels of the variables that are defined in the tabulate parameter.

Default INTERNAL
FORMATTED

uses external formatted value, except for numeric variables that have no explicit format, which are sorted by their unformatted (internal) value.

FREQ

uses descending frequency count (levels that have more observations come earlier in the order).

INTERNAL

uses unformatted value.

outputTables={outputTables}

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

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

Alias displayOut

printLevels=true | false

when set to True, displays the variable level information table.

Default true

tabDisplay={freqTab_tabDisplay}

specifies options to control displayed frequency and crosstabulation tables.

Long form tabDisplay={format="CROSSLIST" | "LIST"}
Shortcut form tabDisplay="CROSSLIST" | "LIST"

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

format="CROSSLIST" | "LIST"

specifies the format for displaying two-way and multiway crosstabulation tables.

Default CROSSLIST
CROSSLIST

uses CROSSLIST format, where a separate two-way crosstabulation table is generated for each stratum of a multiway table.

LIST

uses LIST format, where the entire multiway crosstabulation is presented in a single table.

maxLevels=integer

specifies the maximum number of variable levels to display in one-way frequency tables. A value of 0 means an unlimited number of levels.

Default 0
Minimum value 0
missingFreq=true | false

when set to True, displays missing value frequencies in one-way frequency tables and crosstabulation tables in LIST format but does not include the missing value frequencies in any computations of percentages or statistics.

Default false

* table={castable}

specifies the settings for an input table.

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

tabulate={{freqTab_tabulate-1} <, {freqTab_tabulate-2}, ...>}

specifies the frequency and crosstabulation tables to produce. If you specify the vars parameter only, the frequency or crosstabulation table to produce is made up of variables that you specify in the vars parameter. If you specify the cross parameter along with the vars parameter, each pair of variables (one from the vars parameter and the other from the cross parameter, in this order) defines a two-way crosstabulation table to produce. If you omit the tabulate parameter, one-way frequency tables are generated for all variables that are not specified in other parameters.

Alias crossTabs

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

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

specifies the variables to pair with those specified in the vars parameter to produce two-way crosstabulation tables. Each pair of variables, one from the vars parameter and the other from the cross parameter, in this order, defines a two-way crosstabulation table to produce.

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

specifies the variables to use to produce a frequency or crosstabulation table. To produce a one-way frequency table, specify a single variable. To produce a two-way or multiway crosstabulation table (an n-way table, where n>1), specify at least two variables. For a two-way or multiway table, the values of the last specified variable form the crosstabulation table columns, the values of the next-to-last variable form the rows, and each combination of levels of the other variables forms one stratum.

weight="variable-name"

specifies a numeric variable that provides a weight for each observation in the input data table.

freqTab Action

Constructs the frequency and crosstabulation tables.

Python Syntax

results=s.freqTab.freqTab(
attributes=[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
descending=True | False,
display={
"caseSensitive":True | False,
"exclude":True | False,
"excludeAll":True | False,
"keyIsPath":True | False,
"names":["string-1" <, "string-2", ...>],
"pathType":"LABEL" | "NAME",
"traceNames":True | False
},
groupByLimit=64-bit-integer,
includeMissing=True | False,
includeZeroWeight=True | False,
nLevelsPrint=integer,
order="FORMATTED" | "FREQ" | "INTERNAL",
outputTables={
"groupByVarsRaw":True | False,
"includeAll":True | False,
"names":["string-1" <, "string-2", ...>] | {"key-1":{casouttable-1} <, "key-2":{casouttable-2}, ...>},
"repeated":True | False,
"replace":True | False
},
printLevels=True | False,
tabDisplay={
"format":"CROSSLIST" | "LIST",
"maxLevels":integer,
"missingFreq":True | False
},
required parameter table={
"caslib":"string",
"computedOnDemand":True | False,
"computedVars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"computedVarsProgram":"string",
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},
"groupBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"groupByMode":"NOSORT" | "REDISTRIBUTE",
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},
required parameter "name":"table-name",
"orderBy":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"singlePass":True | False,
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>],
"where":"where-expression",
"whereTable":{
"casLib":"string"
"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}
"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}
required parameter "name":"table-name"
"vars":[{
"format":"string",
"formattedLength":integer,
"label":"string",
required parameter "name":"variable-name",
"nfd":integer,
"nfl":integer
}<, {...}>]
"where":"where-expression"
}
},
tabulate=[{
"cross":["variable-name-1" <, "variable-name-2", ...>],
required parameter "vars":["variable-name-1" <, "variable-name-2", ...>]
}<, {...}>],
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

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outputTables

names

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

Parameter Descriptions

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

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

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

Aliases attribute
attr

descending=True | False

when set to True, reverses the sort order that is imposed by the order parameter.

Default False

display={displayTables}

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

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

groupByLimit=64-bit-integer

suppresses analysis if the number of BY groups exceeds the specified value.

Minimum value 1

includeMissing=True | False

when set to True, treats missing values as valid levels for the variables that are defined in the tabulate parameter.

Default False

includeZeroWeight=True | False

when set to True, includes observations that have weights of 0 in the analysis.

Default False

nLevelsPrint=integer

specifies the maximum number of variable levels to display in the variable level information table. The value 0 suppresses all levels.

Minimum value 0

order="FORMATTED" | "FREQ" | "INTERNAL"

specifies the sort order for the levels of the variables that are defined in the tabulate parameter.

Default INTERNAL
FORMATTED

uses external formatted value, except for numeric variables that have no explicit format, which are sorted by their unformatted (internal) value.

FREQ

uses descending frequency count (levels that have more observations come earlier in the order).

INTERNAL

uses unformatted value.

outputTables={outputTables}

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

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

Alias displayOut

printLevels=True | False

when set to True, displays the variable level information table.

Default True

tabDisplay={freqTab_tabDisplay}

specifies options to control displayed frequency and crosstabulation tables.

Long form tabDisplay={"format":"CROSSLIST" | "LIST"}
Shortcut form tabDisplay="CROSSLIST" | "LIST"

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

"format":"CROSSLIST" | "LIST"

specifies the format for displaying two-way and multiway crosstabulation tables.

Default CROSSLIST
CROSSLIST

uses CROSSLIST format, where a separate two-way crosstabulation table is generated for each stratum of a multiway table.

LIST

uses LIST format, where the entire multiway crosstabulation is presented in a single table.

"maxLevels":integer

specifies the maximum number of variable levels to display in one-way frequency tables. A value of 0 means an unlimited number of levels.

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

when set to True, displays missing value frequencies in one-way frequency tables and crosstabulation tables in LIST format but does not include the missing value frequencies in any computations of percentages or statistics.

Default False

* table={castable}

specifies the settings for an input table.

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

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

specifies the frequency and crosstabulation tables to produce. If you specify the vars parameter only, the frequency or crosstabulation table to produce is made up of variables that you specify in the vars parameter. If you specify the cross parameter along with the vars parameter, each pair of variables (one from the vars parameter and the other from the cross parameter, in this order) defines a two-way crosstabulation table to produce. If you omit the tabulate parameter, one-way frequency tables are generated for all variables that are not specified in other parameters.

Alias crossTabs

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

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

specifies the variables to pair with those specified in the vars parameter to produce two-way crosstabulation tables. Each pair of variables, one from the vars parameter and the other from the cross parameter, in this order, defines a two-way crosstabulation table to produce.

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

specifies the variables to use to produce a frequency or crosstabulation table. To produce a one-way frequency table, specify a single variable. To produce a two-way or multiway crosstabulation table (an n-way table, where n>1), specify at least two variables. For a two-way or multiway table, the values of the last specified variable form the crosstabulation table columns, the values of the next-to-last variable form the rows, and each combination of levels of the other variables forms one stratum.

weight="variable-name"

specifies a numeric variable that provides a weight for each observation in the input data table.

freqTab Action

Constructs the frequency and crosstabulation tables.

R Syntax

results <– cas.freqTab.freqTab(s,
attributes=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
descending=TRUE | FALSE,
display=list(
caseSensitive=TRUE | FALSE,
exclude=TRUE | FALSE,
excludeAll=TRUE | FALSE,
keyIsPath=TRUE | FALSE,
names=list("string-1" <, "string-2", ...>),
pathType="LABEL" | "NAME",
traceNames=TRUE | FALSE
),
groupByLimit=64-bit-integer,
includeMissing=TRUE | FALSE,
includeZeroWeight=TRUE | FALSE,
nLevelsPrint=integer,
order="FORMATTED" | "FREQ" | "INTERNAL",
outputTables=list(
groupByVarsRaw=TRUE | FALSE,
includeAll=TRUE | FALSE,
names=list("string-1" <, "string-2", ...>) | list(key-1=list(casouttable-1) <, key-2=list(casouttable-2), ...>),
repeated=TRUE | FALSE,
replace=TRUE | FALSE
),
printLevels=TRUE | FALSE,
tabDisplay=list(
format="CROSSLIST" | "LIST",
maxLevels=integer,
missingFreq=TRUE | FALSE
),
required parameter table=list(
caslib="string",
computedOnDemand=TRUE | FALSE,
computedVars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
computedVarsProgram="string",
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>),
groupBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
groupByMode="NOSORT" | "REDISTRIBUTE",
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters),
required parameter name="table-name",
orderBy=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
singlePass=TRUE | FALSE,
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>),
where="where-expression",
whereTable=list(
casLib="string"
dataSourceOptions=list(adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters)
importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)
required parameter name="table-name"
vars=list( list(
format="string",
formattedLength=integer,
label="string",
required parameter name="variable-name",
nfd=integer,
nfl=integer
) <, list(...)>)
where="where-expression"
)
),
tabulate=list( list(
cross=list("variable-name-1" <, "variable-name-2", ...>),
required parameter vars=list("variable-name-1" <, "variable-name-2", ...>)
) <, list(...)>),
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

required parametertable

—

specifies the settings for an input table.
Parameters for Creating Output Tables

Parameter

Subparameter

Description

 outputTables

names

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

Parameter Descriptions

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

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

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

Aliases attribute
attr

descending=TRUE | FALSE

when set to True, reverses the sort order that is imposed by the order parameter.

Default FALSE

display=list(displayTables)

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

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

groupByLimit=64-bit-integer

suppresses analysis if the number of BY groups exceeds the specified value.

Minimum value 1

includeMissing=TRUE | FALSE

when set to True, treats missing values as valid levels for the variables that are defined in the tabulate parameter.

Default FALSE

includeZeroWeight=TRUE | FALSE

when set to True, includes observations that have weights of 0 in the analysis.

Default FALSE

nLevelsPrint=integer

specifies the maximum number of variable levels to display in the variable level information table. The value 0 suppresses all levels.

Minimum value 0

order="FORMATTED" | "FREQ" | "INTERNAL"

specifies the sort order for the levels of the variables that are defined in the tabulate parameter.

Default INTERNAL
FORMATTED

uses external formatted value, except for numeric variables that have no explicit format, which are sorted by their unformatted (internal) value.

FREQ

uses descending frequency count (levels that have more observations come earlier in the order).

INTERNAL

uses unformatted value.

outputTables=list(outputTables)

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

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

Alias displayOut

printLevels=TRUE | FALSE

when set to True, displays the variable level information table.

Default TRUE

tabDisplay=list(freqTab_tabDisplay)

specifies options to control displayed frequency and crosstabulation tables.

Long form tabDisplay=list(format="CROSSLIST" | "LIST")
Shortcut form tabDisplay="CROSSLIST" | "LIST"

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

format="CROSSLIST" | "LIST"

specifies the format for displaying two-way and multiway crosstabulation tables.

Default CROSSLIST
CROSSLIST

uses CROSSLIST format, where a separate two-way crosstabulation table is generated for each stratum of a multiway table.

LIST

uses LIST format, where the entire multiway crosstabulation is presented in a single table.

maxLevels=integer

specifies the maximum number of variable levels to display in one-way frequency tables. A value of 0 means an unlimited number of levels.

Default 0
Minimum value 0
missingFreq=TRUE | FALSE

when set to True, displays missing value frequencies in one-way frequency tables and crosstabulation tables in LIST format but does not include the missing value frequencies in any computations of percentages or statistics.

Default FALSE

* table=list(castable)

specifies the settings for an input table.

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

tabulate=list( list(freqTab_tabulate-1) <, list(freqTab_tabulate-2), ...>)

specifies the frequency and crosstabulation tables to produce. If you specify the vars parameter only, the frequency or crosstabulation table to produce is made up of variables that you specify in the vars parameter. If you specify the cross parameter along with the vars parameter, each pair of variables (one from the vars parameter and the other from the cross parameter, in this order) defines a two-way crosstabulation table to produce. If you omit the tabulate parameter, one-way frequency tables are generated for all variables that are not specified in other parameters.

Alias crossTabs

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

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

specifies the variables to pair with those specified in the vars parameter to produce two-way crosstabulation tables. Each pair of variables, one from the vars parameter and the other from the cross parameter, in this order, defines a two-way crosstabulation table to produce.

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

specifies the variables to use to produce a frequency or crosstabulation table. To produce a one-way frequency table, specify a single variable. To produce a two-way or multiway crosstabulation table (an n-way table, where n>1), specify at least two variables. For a two-way or multiway table, the values of the last specified variable form the crosstabulation table columns, the values of the next-to-last variable form the rows, and each combination of levels of the other variables forms one stratum.

weight="variable-name"

specifies a numeric variable that provides a weight for each observation in the input data table.

Last updated: March 05, 2026