Association Rule Mining Action Set: Syntax
Provides actions for association rule mining
mbanalysis Action
Performs rule generation for market basket analysis.
CASL Syntax
Parameter Descriptions
antecedentList={"string-1" <, "string-2", ...>}
specifies the regular expression strings to match in the antecedent (left-hand side) of a rule.
conf=double
specifies the minimum confidence for the rules.
| Default | 50 |
| Range | 0–100 |
consequentList={"string-1" <, "string-2", ...>}
specifies the regular expression strings to match in the consequent (right-hand side) of a rule.
hierarchy={{castable-1} <, {castable-2}, ...>}
specifies one or more hierarchy tables. If you omit this parameter, then the mbanalysis action performs simple association analysis without a hierarchy. You can specify up to five tables; each table specifies one level of the hierarchy.
| Maximum items | 5 |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* idVariable="variable-name"
specifies variable that is used to group the target variable into baskets.
items=integer
specifies the number of items in a rule. The default value is 2 when either the out parameter or outrule parameter is specified and 1 otherwise.
| Default | 2 |
| Range | 1–1000 |
lift=double
specifies the minimum lift value necessary to generate a rule.
| Default | 1 |
| Range | 0–100 |
maxItems=integer
specifies a maximum basket size, such that baskets larger than the specified value are rejected.
| Default | 1000 |
| Range | 0–1000 |
minItems=integer
specifies a minimum basket size, such that baskets smaller than the specified value are rejected.
| Default | 1 |
| Range | 0–20 |
nLHS_range={nLHSRHSOpts}
* lower=integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* upper=integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
nRHS_range={nLHSRHSOpts}
* lower=integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* upper=integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
norm=TRUE | FALSE
when set to True, normalizes the values of the target variable and the items in the out tables.
| Default | FALSE |
out={casouttable}
specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
For more information about specifying the out parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outfreq={casouttable}
specifies the table to contain the unique frequent items along with their transaction counts and support.
For more information about specifying the outfreq parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outrule={casouttable}
specifies the table to contain the rules. This output table includes variables that identify the left-hand and right-hand sides of the rule, the support, and the lift.
For more information about specifying the outrule parameter, see the common casouttable parameter (Appendix A: Common Parameters).
saveState={casouttable}
specifies the table in which to save the model for future scoring.
For more information about specifying the saveState parameter, see the common casouttable parameter (Appendix A: Common Parameters).
separator="string"
specifies the separator character in the antecedent (left-hand side) or the consequent (right-hand side) of a rule. The default value is "&".
sup_lift=double
specifies the minimum support lift necessary to generate a rule.
| Default | 0 |
supmin=double
specifies the minimum level of support for a rule. This represents the minimum allowable frequency of an item. This parameter overrides the suppct parameter.
| Minimum value | 0 |
suppct=double
specifies the minimum level of support for a rule as a percentage of the number of baskets in the input data table.
| Range | 0–100 |
* table={castable}
specifies the settings for an input table.
| Long form | table={name="table-name"} |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* tgtVariable="variable-name"
specifies a single nominal variable to use as the target variable. If this variable is not present in the data table that is specified in the table parameter, then the action exits with an error.
mbanalysis Action
Performs rule generation for market basket analysis.
Lua Syntax
Parameter Descriptions
antecedentList={"string-1" <, "string-2", ...>}
specifies the regular expression strings to match in the antecedent (left-hand side) of a rule.
conf=double
specifies the minimum confidence for the rules.
| Default | 50 |
| Range | 0–100 |
consequentList={"string-1" <, "string-2", ...>}
specifies the regular expression strings to match in the consequent (right-hand side) of a rule.
hierarchy={{castable-1} <, {castable-2}, ...>}
specifies one or more hierarchy tables. If you omit this parameter, then the mbanalysis action performs simple association analysis without a hierarchy. You can specify up to five tables; each table specifies one level of the hierarchy.
| Maximum items | 5 |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=true | false
This parameter is deprecated.
| Default | true |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* idVariable="variable-name"
specifies variable that is used to group the target variable into baskets.
items=integer
specifies the number of items in a rule. The default value is 2 when either the out parameter or outrule parameter is specified and 1 otherwise.
| Default | 2 |
| Range | 1–1000 |
lift=double
specifies the minimum lift value necessary to generate a rule.
| Default | 1 |
| Range | 0–100 |
maxItems=integer
specifies a maximum basket size, such that baskets larger than the specified value are rejected.
| Default | 1000 |
| Range | 0–1000 |
minItems=integer
specifies a minimum basket size, such that baskets smaller than the specified value are rejected.
| Default | 1 |
| Range | 0–20 |
nLHS_range={nLHSRHSOpts}
* lower=integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* upper=integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
nRHS_range={nLHSRHSOpts}
* lower=integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* upper=integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
norm=true | false
when set to True, normalizes the values of the target variable and the items in the out tables.
| Default | false |
out={casouttable}
specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
For more information about specifying the out parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outfreq={casouttable}
specifies the table to contain the unique frequent items along with their transaction counts and support.
For more information about specifying the outfreq parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outrule={casouttable}
specifies the table to contain the rules. This output table includes variables that identify the left-hand and right-hand sides of the rule, the support, and the lift.
For more information about specifying the outrule parameter, see the common casouttable parameter (Appendix A: Common Parameters).
saveState={casouttable}
specifies the table in which to save the model for future scoring.
For more information about specifying the saveState parameter, see the common casouttable parameter (Appendix A: Common Parameters).
separator="string"
specifies the separator character in the antecedent (left-hand side) or the consequent (right-hand side) of a rule. The default value is "&".
sup_lift=double
specifies the minimum support lift necessary to generate a rule.
| Default | 0 |
supmin=double
specifies the minimum level of support for a rule. This represents the minimum allowable frequency of an item. This parameter overrides the suppct parameter.
| Minimum value | 0 |
suppct=double
specifies the minimum level of support for a rule as a percentage of the number of baskets in the input data table.
| Range | 0–100 |
* table={castable}
specifies the settings for an input table.
| Long form | table={name="table-name"} |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=true | false
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | false |
computedVars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>}
specifies data source options.
| Alias | options, dataSource |
groupBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions={fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=true | false
This parameter is deprecated.
| Default | true |
orderBy={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=true | false
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | false |
vars={{casinvardesc-1} <, {casinvardesc-2}, ...>}
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* tgtVariable="variable-name"
specifies a single nominal variable to use as the target variable. If this variable is not present in the data table that is specified in the table parameter, then the action exits with an error.
mbanalysis Action
Performs rule generation for market basket analysis.
Python Syntax
Parameter Descriptions
antecedentList=["string-1" <, "string-2", ...>]
specifies the regular expression strings to match in the antecedent (left-hand side) of a rule.
conf=double
specifies the minimum confidence for the rules.
| Default | 50 |
| Range | 0–100 |
consequentList=["string-1" <, "string-2", ...>]
specifies the regular expression strings to match in the consequent (right-hand side) of a rule.
hierarchy=[{castable-1} <, {castable-2}, ...>]
specifies one or more hierarchy tables. If you omit this parameter, then the mbanalysis action performs simple association analysis without a hierarchy. You can specify up to five tables; each table specifies one level of the hierarchy.
| Maximum items | 5 |
| The castable value can be one or more of the following: |
"caslib":"string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"computedVarsProgram":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Alias | options, dataSource |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* "name":"table-name"
specifies the name of the table to use.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"where":"where-expression"
specifies an expression for subsetting the input data.
* idVariable="variable-name"
specifies variable that is used to group the target variable into baskets.
items=integer
specifies the number of items in a rule. The default value is 2 when either the out parameter or outrule parameter is specified and 1 otherwise.
| Default | 2 |
| Range | 1–1000 |
lift=double
specifies the minimum lift value necessary to generate a rule.
| Default | 1 |
| Range | 0–100 |
maxItems=integer
specifies a maximum basket size, such that baskets larger than the specified value are rejected.
| Default | 1000 |
| Range | 0–1000 |
minItems=integer
specifies a minimum basket size, such that baskets smaller than the specified value are rejected.
| Default | 1 |
| Range | 0–20 |
nLHS_range={nLHSRHSOpts}
* "lower":integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* "upper":integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
nRHS_range={nLHSRHSOpts}
* "lower":integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* "upper":integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
norm=True | False
when set to True, normalizes the values of the target variable and the items in the out tables.
| Default | False |
out={casouttable}
specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
For more information about specifying the out parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outfreq={casouttable}
specifies the table to contain the unique frequent items along with their transaction counts and support.
For more information about specifying the outfreq parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outrule={casouttable}
specifies the table to contain the rules. This output table includes variables that identify the left-hand and right-hand sides of the rule, the support, and the lift.
For more information about specifying the outrule parameter, see the common casouttable parameter (Appendix A: Common Parameters).
saveState={casouttable}
specifies the table in which to save the model for future scoring.
For more information about specifying the saveState parameter, see the common casouttable parameter (Appendix A: Common Parameters).
separator="string"
specifies the separator character in the antecedent (left-hand side) or the consequent (right-hand side) of a rule. The default value is "&".
sup_lift=double
specifies the minimum support lift necessary to generate a rule.
| Default | 0 |
supmin=double
specifies the minimum level of support for a rule. This represents the minimum allowable frequency of an item. This parameter overrides the suppct parameter.
| Minimum value | 0 |
suppct=double
specifies the minimum level of support for a rule as a percentage of the number of baskets in the input data table.
| Range | 0–100 |
* table={castable}
specifies the settings for an input table.
| Long form | table={"name":"table-name"} |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
"caslib":"string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
"computedOnDemand":True | False
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | False |
"computedVars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"computedVarsProgram":"string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>}
specifies data source options.
| Alias | options, dataSource |
"groupBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the names of the variables to use for grouping results.
"format":"string"
specifies the format to apply to the variable.
"formattedLength":integer
specifies the length of format field plus the format precision.
"label":"string"
specifies the descriptive label for the variable.
* "name":"variable-name"
specifies the name for the variable.
"nfd":integer
specifies the length of the format precision.
"nfl":integer
specifies the length of the format field.
"groupByMode":"NOSORT" | "REDISTRIBUTE"
"importOptions":{fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters}
specifies the settings for reading a table from a data source.
| Alias | import_ |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* "name":"table-name"
specifies the name of the table to use.
"onDemand":True | False
This parameter is deprecated.
| Default | True |
"orderBy":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"singlePass":True | False
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | False |
"vars":[{casinvardesc-1} <, {casinvardesc-2}, ...>]
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
"where":"where-expression"
specifies an expression for subsetting the input data.
* tgtVariable="variable-name"
specifies a single nominal variable to use as the target variable. If this variable is not present in the data table that is specified in the table parameter, then the action exits with an error.
mbanalysis Action
Performs rule generation for market basket analysis.
R Syntax
Parameter Descriptions
antecedentList=list("string-1" <, "string-2", ...>)
specifies the regular expression strings to match in the antecedent (left-hand side) of a rule.
conf=double
specifies the minimum confidence for the rules.
| Default | 50 |
| Range | 0–100 |
consequentList=list("string-1" <, "string-2", ...>)
specifies the regular expression strings to match in the consequent (right-hand side) of a rule.
hierarchy=list( list(castable-1) <, list(castable-2), ...>)
specifies one or more hierarchy tables. If you omit this parameter, then the mbanalysis action performs simple association analysis without a hierarchy. You can specify up to five tables; each table specifies one level of the hierarchy.
| Maximum items | 5 |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Alias | options, dataSource |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* idVariable="variable-name"
specifies variable that is used to group the target variable into baskets.
items=integer
specifies the number of items in a rule. The default value is 2 when either the out parameter or outrule parameter is specified and 1 otherwise.
| Default | 2 |
| Range | 1–1000 |
lift=double
specifies the minimum lift value necessary to generate a rule.
| Default | 1 |
| Range | 0–100 |
maxItems=integer
specifies a maximum basket size, such that baskets larger than the specified value are rejected.
| Default | 1000 |
| Range | 0–1000 |
minItems=integer
specifies a minimum basket size, such that baskets smaller than the specified value are rejected.
| Default | 1 |
| Range | 0–20 |
nLHS_range=list(nLHSRHSOpts)
* lower=integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* upper=integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
nRHS_range=list(nLHSRHSOpts)
* lower=integer
specifies the minimum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1 |
| Range | 1–1000 |
* upper=integer
specifies the maximum number of items in the left-hand side or right-hand side (LHS/RHS) of a rule.
| Default | 1000 |
| Range | 1–1000 |
norm=TRUE | FALSE
when set to True, normalizes the values of the target variable and the items in the out tables.
| Default | FALSE |
out=list(casouttable)
specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
For more information about specifying the out parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outfreq=list(casouttable)
specifies the table to contain the unique frequent items along with their transaction counts and support.
For more information about specifying the outfreq parameter, see the common casouttable parameter (Appendix A: Common Parameters).
outrule=list(casouttable)
specifies the table to contain the rules. This output table includes variables that identify the left-hand and right-hand sides of the rule, the support, and the lift.
For more information about specifying the outrule parameter, see the common casouttable parameter (Appendix A: Common Parameters).
saveState=list(casouttable)
specifies the table in which to save the model for future scoring.
For more information about specifying the saveState parameter, see the common casouttable parameter (Appendix A: Common Parameters).
separator="string"
specifies the separator character in the antecedent (left-hand side) or the consequent (right-hand side) of a rule. The default value is "&".
sup_lift=double
specifies the minimum support lift necessary to generate a rule.
| Default | 0 |
supmin=double
specifies the minimum level of support for a rule. This represents the minimum allowable frequency of an item. This parameter overrides the suppct parameter.
| Minimum value | 0 |
suppct=double
specifies the minimum level of support for a rule as a percentage of the number of baskets in the input data table.
| Range | 0–100 |
* table=list(castable)
specifies the settings for an input table.
| Long form | table=list(name="table-name") |
| Shortcut form | table="table-name" |
| The castable value can be one or more of the following: |
caslib="string"
specifies the caslib that contains the table that you want to use with the action. By default, the active caslib is used. Specify a value only if you need to access a table from a different caslib.
computedOnDemand=TRUE | FALSE
when set to True, creates the computed variables when the table is loaded instead of when the action begins.
| Alias | compOnDemand |
| Default | FALSE |
computedVars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter.
| Alias | compVars |
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
computedVarsProgram="string"
specifies an expression for each computed variable that you include in the computedVars parameter.
| Alias | compPgm |
dataSourceOptions=list(key-1=list(any-list-or-data-type-1) <, key-2=list(any-list-or-data-type-2), ...>)
specifies data source options.
| Alias | options, dataSource |
groupBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the names of the variables to use for grouping results.
format="string"
specifies the format to apply to the variable.
formattedLength=integer
specifies the length of format field plus the format precision.
label="string"
specifies the descriptive label for the variable.
* name="variable-name"
specifies the name for the variable.
nfd=integer
specifies the length of the format precision.
nfl=integer
specifies the length of the format field.
groupByMode="NOSORT" | "REDISTRIBUTE"
importOptions=list(fileType="AUTO" | "BASESAS" | "CSV" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "JMP" | "LASR" | "SPSS" | "XLS", fileType-specific-parameters)
specifies the settings for reading a table from a data source.
| Alias | import |
The value that you specify for fileType determines the other parameters that apply. For more information about this common parameter, see importOptions (Appendix A: Common Parameters).
* name="table-name"
specifies the name of the table to use.
onDemand=TRUE | FALSE
This parameter is deprecated.
| Default | TRUE |
orderBy=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use for ordering observations within partitions. This parameter applies to partitioned tables, or it can be combined with variables that are specified in the groupBy parameter when the value of the groupByMode parameter is set to REDISTRIBUTE.
For more information about specifying the orderBy parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
singlePass=TRUE | FALSE
when set to True, does not create a transient table on the server. Setting this parameter to True can be efficient, but the data might not have stable ordering upon repeated runs.
| Default | FALSE |
vars=list( list(casinvardesc-1) <, list(casinvardesc-2), ...>)
specifies the variables to use in the action.
For more information about specifying the vars parameter, see the common casinvardesc parameter (Appendix A: Common Parameters).
where="where-expression"
specifies an expression for subsetting the input data.
* tgtVariable="variable-name"
specifies a single nominal variable to use as the target variable. If this variable is not present in the data table that is specified in the table parameter, then the action exits with an error.