IDAX.ASSOCRULES - Build an association rules model

Authorization

The privileges held by the authorization ID of the statement must include the IDAX_USER role.

Syntax

IDAX.ASSOCRULES(in parameter_string varchar(32672))

Parameter descriptions

parameter_string

Mandatory one-string parameter that contains pairs of <parameter>=<value> entries that are separated by a comma.

Data type: VARCHAR(32672)

The following list shows the parameter values:

model

Mandatory.

The name of the association rules model that is to be build.

Data type: VARCHAR(192)

intable

Mandatory.

The name of the input table.

Data type: VARCHAR(128)

tid

Mandatory.

The column of the input table that identifies the transaction ID.

Data type: VARCHAR(128)

item

Mandatory.

The column of the input table that identifies an item of the transaction.

Data type: VARCHAR(128)

minsupport

Optional.

The minimum fraction (0.0 - 1.0) or the minimum number (above 1) of transactions that must contain a pattern to be considered as frequent.

Default: system-determined

Range: >0.0 and <1.0 for a minimum fraction; >1 for a minimum number of transactions.

Data type: DOUBLE

maxlen

Optional.

The maximum length of a pattern or a rule, that is, the maximum number of items per pattern or rule.

Default: 5

Range: >=2

Data type: INTEGER

maxheadlen

Optional.

The maximum length of a rule head, that is, the maximum number of items that might belong to the item set on the right side of a rule.

Increasing this value might significantly increase the number of detected rules.

Default: 1

Range: >=1 and <maxlen

Data type: INTEGER

minconf

Optional.

The minimum confidence that a rule must achieve to be kept in the model of the pattern.

Default: 0.5

Range: >=0.0 and <= 1

Data type: DOUBLE

nametable

Optional.

The table that contains a mapping of the items in the input table and their names.

The table must contain at least two columns, where

1. The first column has the same name as the column that is contained in the item parameter of the input table
2. The second column has the same name as the name that is defined in the namecol parameter

Default: No table

Data type: VARCHAR(128)

namecol

Optional.

The column that contains the item name that is defined in the nametable parameter.

You cannot specify this parameter if the nametable parameter is not specified.

Default: name

Data type: VARCHAR(128)

Returned information

The number of rules that are detected as a result set.

Example

CALL IDAX.ASSOCRULES('model=retail_assoc, intable=retail, tid=tid, item=item, minsupport=0.05, minconf=0.5');