Association Rule Mining Action Set

Provides actions for association rule mining

mbanalysis Action

Performs rule generation for market basket analysis.

CASL Syntax
Summary: Input and Output Tables
Parameter Descriptions

CASL Syntax

ruleMining.mbanalysis <result=results> <status=rc> /

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

conf=double,

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

hierarchy={{

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},

name="table-name",

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable={

casLib="string"

dataSourceOptions={adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

}, {...}},

idVariable="variable-name",

items=integer,

lift=double,

maxItems=integer,

minItems=integer,

nLHS_range={

lower=integer,

upper=integer

norm=TRUE | FALSE,

nRHS_range={

lower=integer,

upper=integer

out={

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

outfreq={

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

outrule={

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

saveState={

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

separator="string",

sup_lift=double,

supmin=double,

suppct=double,

table={

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=TRUE | FALSE,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

tgtVariable="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
hierarchy	—	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.
required parametertable	—	specifies the settings for an input table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
out	—	specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
outfreq	—	specifies the table to contain the unique frequent items along with their transaction counts and support.
outrule	—	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.
saveState	—	specifies the table in which to save the model for future scoring.

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.

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

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

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

* 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

nRHS_range={nLHSRHSOpts}

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

* 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

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 (Form 1) 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 (Form 1) 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 (Form 1) 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 (Form 1) 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	1

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.

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

* 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
Summary: Input and Output Tables
Parameter Descriptions

Lua Syntax

results, info = s:ruleMining_mbanalysis{

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

conf=double,

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

hierarchy={{

caslib="string",

computedOnDemand=true | false,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

}, {...}},

idVariable="variable-name",

items=integer,

lift=double,

maxItems=integer,

minItems=integer,

nLHS_range={

lower=integer,

upper=integer

norm=true | false,

nRHS_range={

lower=integer,

upper=integer

out={

caslib="string",

compress=true | false,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=true | false,

replace=true | false,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

outfreq={

caslib="string",

compress=true | false,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=true | false,

replace=true | false,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

outrule={

caslib="string",

compress=true | false,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=true | false,

replace=true | false,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

saveState={

caslib="string",

compress=true | false,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=true | false,

replace=true | false,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

separator="string",

sup_lift=double,

supmin=double,

suppct=double,

table={

caslib="string",

computedOnDemand=true | false,

computedVars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

computedVarsProgram="string",

dataSourceOptions={key-1=any-list-or-data-type-1 <, key-2=any-list-or-data-type-2, ...>},

groupBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

singlePass=true | false,

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}},

where="where-expression",

whereTable={

casLib="string"

name="table-name"

vars={{

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

}, {...}}

where="where-expression"

}

tgtVariable="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
hierarchy	—	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.
required parametertable	—	specifies the settings for an input table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
out	—	specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
outfreq	—	specifies the table to contain the unique frequent items along with their transaction counts and support.
outrule	—	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.
saveState	—	specifies the table in which to save the model for future scoring.

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

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

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

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

* 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

nRHS_range={nLHSRHSOpts}

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

* 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

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 (Form 1) 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 (Form 1) 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 (Form 1) 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 (Form 1) 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	1

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.

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

* 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
Summary: Input and Output Tables
Parameter Descriptions

Python Syntax

results=s.ruleMining.mbanalysis(

antecedentList=["string-1" <, "string-2", ...>],

conf=double,

consequentList=["string-1" <, "string-2", ...>],

hierarchy=[{

"caslib":"string",

"computedOnDemand":True | False,

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},

"groupBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"groupByMode":"NOSORT" | "REDISTRIBUTE",

"importOptions":{"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters},

"name":"table-name",

"orderBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"singlePass":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"whereTable":{

"casLib":"string"

"dataSourceOptions":{adls_noreq-parameters | bigquery-parameters | cas_noreq-parameters | clouddex-parameters | db2-parameters | dnfs-parameters | esp-parameters | fedsvr-parameters | gcs_noreq-parameters | hadoop-parameters | hana-parameters | impala-parameters | informix-parameters | jdbc-parameters | mongodb-parameters | mysql-parameters | odbc-parameters | oracle-parameters | path-parameters | postgres-parameters | redshift-parameters | s3-parameters | sapiq-parameters | sforce-parameters | singlestore_standard-parameters | snowflake-parameters | spark-parameters | spde-parameters | sqlserver-parameters | ss_noreq-parameters | teradata-parameters | vertica-parameters | yellowbrick-parameters}

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

}<, {...}>],

idVariable="variable-name",

items=integer,

lift=double,

maxItems=integer,

minItems=integer,

nLHS_range={

"lower":integer,

"upper":integer

norm=True | False,

nRHS_range={

"lower":integer,

"upper":integer

out={

"caslib":"string",

"compress":True | False,

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

"label":"string",

"lifetime":64-bit-integer,

"maxMemSize":64-bit-integer,

"memoryFormat":"DVR" | "INHERIT" | "STANDARD",

"name":"table-name",

"promote":True | False,

"replace":True | False,

"replication":integer,

"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

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

outfreq={

"caslib":"string",

"compress":True | False,

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

"label":"string",

"lifetime":64-bit-integer,

"maxMemSize":64-bit-integer,

"memoryFormat":"DVR" | "INHERIT" | "STANDARD",

"name":"table-name",

"promote":True | False,

"replace":True | False,

"replication":integer,

"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

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

outrule={

"caslib":"string",

"compress":True | False,

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

"label":"string",

"lifetime":64-bit-integer,

"maxMemSize":64-bit-integer,

"memoryFormat":"DVR" | "INHERIT" | "STANDARD",

"name":"table-name",

"promote":True | False,

"replace":True | False,

"replication":integer,

"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

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

saveState={

"caslib":"string",

"compress":True | False,

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

"label":"string",

"lifetime":64-bit-integer,

"maxMemSize":64-bit-integer,

"memoryFormat":"DVR" | "INHERIT" | "STANDARD",

"name":"table-name",

"promote":True | False,

"replace":True | False,

"replication":integer,

"tableRedistUpPolicy":"DEFER" | "NOREDIST" | "REBALANCE",

"threadBlockSize":64-bit-integer,

"timeStamp":"string",

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

separator="string",

sup_lift=double,

supmin=double,

suppct=double,

table={

"caslib":"string",

"computedOnDemand":True | False,

"computedVars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"computedVarsProgram":"string",

"dataSourceOptions":{"key-1":{any-list-or-data-type-1} <, "key-2":{any-list-or-data-type-2}, ...>},

"groupBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"groupByMode":"NOSORT" | "REDISTRIBUTE",

"name":"table-name",

"orderBy":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"singlePass":True | False,

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>],

"where":"where-expression",

"whereTable":{

"casLib":"string"

"name":"table-name"

"vars":[{

"format":"string",

"formattedLength":integer,

"label":"string",

"name":"variable-name",

"nfd":integer,

"nfl":integer

}<, {...}>]

"where":"where-expression"

}

tgtVariable="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
hierarchy	—	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.
required parametertable	—	specifies the settings for an input table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
out	—	specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
outfreq	—	specifies the table to contain the unique frequent items along with their transaction counts and support.
outrule	—	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.
saveState	—	specifies the table in which to save the model for future scoring.

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

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

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

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

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

nRHS_range={nLHSRHSOpts}

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

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

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 (Form 1) 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 (Form 1) 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 (Form 1) 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 (Form 1) 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	1

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.

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

* 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
Summary: Input and Output Tables
Parameter Descriptions

R Syntax

results <– cas.ruleMining.mbanalysis(s,

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

conf=double,

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

hierarchy=list( list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

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

name="variable-name",

nfd=integer,

nfl=integer

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

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

singlePass=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

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

idVariable="variable-name",

items=integer,

lift=double,

maxItems=integer,

minItems=integer,

nLHS_range=list(

lower=integer,

upper=integer

norm=TRUE | FALSE,

nRHS_range=list(

lower=integer,

upper=integer

out=list(

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

outfreq=list(

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

outrule=list(

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

saveState=list(

caslib="string",

compress=TRUE | FALSE,

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

label="string",

lifetime=64-bit-integer,

maxMemSize=64-bit-integer,

memoryFormat="DVR" | "INHERIT" | "STANDARD",

name="table-name",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

replication=integer,

tableRedistUpPolicy="DEFER" | "NOREDIST" | "REBALANCE",

threadBlockSize=64-bit-integer,

timeStamp="string",

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

separator="string",

sup_lift=double,

supmin=double,

suppct=double,

table=list(

caslib="string",

computedOnDemand=TRUE | FALSE,

computedVars=list( list(

format="string",

formattedLength=integer,

label="string",

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

name="variable-name",

nfd=integer,

nfl=integer

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

groupByMode="NOSORT" | "REDISTRIBUTE",

name="table-name",

orderBy=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

singlePass=TRUE | FALSE,

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

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

where="where-expression",

whereTable=list(

casLib="string"

name="table-name"

vars=list( list(

format="string",

formattedLength=integer,

label="string",

name="variable-name",

nfd=integer,

nfl=integer

) <, list(...)>)

where="where-expression"

)

tgtVariable="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
hierarchy	—	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.
required parametertable	—	specifies the settings for an input table.

Parameters for Creating Output Tables
Parameter	Subparameter	Description
out	—	specifies the table to contain frequent item sets to generate rules. This output table also includes transaction counts and support.
outfreq	—	specifies the table to contain the unique frequent items along with their transaction counts and support.
outrule	—	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.
saveState	—	specifies the table in which to save the model for future scoring.

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

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

* 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)

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

* 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

nRHS_range=list(nLHSRHSOpts)

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

* 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

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 (Form 1) 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 (Form 1) 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 (Form 1) 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 (Form 1) 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	1

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.

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

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

Last updated: November 23, 2025