Use this stored procedure to prune the rules and patterns of an association rules
model.
To remove rules and pattern which you are not interested in, you can use filters to exclude
these rules and patterns. These rules and patterns are then marked as not valid in the model and are
no longer shown.
Authorization
The privileges held by the authorization ID of the statement must include the IDAX_USER role.
Additionally, you must be the owner of the model or have the authority to alter it.
Syntax
IDAX.PRUNE_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 pruned.
- Data type: VARCHAR(192)
- itemsin
- Optional.
- A list of item names that must be contained in the rules or patterns to be kept. The items are
separated by semicolons. At least one of the listed items must be contained in a rule or pattern to
be kept.
- Default: none
- For rules, the following conditions apply:
- To indicate that the item must be contained in the head of the rule, the item names can be
succeeded by :h or :head.
- To indicate that the item must be contained in the body of the rule, the item names can be
succeeded by :b or :body
- Data type: VARCHAR(32000)
- If this parameter is not specified, no constraint is applied.
- itemsout
- Optional.
- A list of item names that must not be contained in the rules or patterns to be kept. The items
are separated by semicolons.
- Default: none
- Data type: VARCHAR(32000)
- If this parameter is not specified, no constraint is applied.
- minlen
- Optional.
- The minimum number of items that are to be kept in the rules or patterns.
- Default: 1
- Range: >= 1 and <= maxlen
- Data type: INTEGER
- maxlen
- Optional.
- The maximum number of items that are to be kept in the rules or patterns.
- Default: the longest pattern of the model
- Range: >= 1
- Data type: INTEGER
- minsupport
- Optional.
- The minimum support for the rules or patterns that are to be kept.
- Default: 0.0
- Range: >=0.0 and <=maxsupport
- Data type: DOUBLE
- maxsupport
- Optional.
- The maximum support for the rules or patterns that are to be kept.
- Default: 1.0
- Range: >=minsupport and <=1.0
- Data type: DOUBLE
- minlift
- Optional.
- The minimum lift of the rules or patterns that are to be kept.
- Default: 0.0
- Range: >=0.0 and <=maxlift
- Data type: DOUBLE
- maxlift
- Optional.
- The maximum lift of the rules or patterns that are to be kept.
- Default: the maximum lift of the patterns of the model
- Range: >=minlift
- Data type: DOUBLE
- minconf
- Optional.
- The minimum confidence of the rules that are to be kept.
- Default: 0.0
- Data type: DOUBLE
- Range: >=0.0 and <= maxconf
- maxconf
- Optional.
- The maximum confidence of the rules that are to be kept.
- Default: 1.0
- Data type: DOUBLE
- Range: >=minconf and <= 1.0
- reset
- Optional.
- Default: false
- Data type: BOOLEAN
- If you specify reset=true, all rules and patterns are first reset to
not pruned.
- If you specify reset=true or reset=false, the rules
and patterns that are not to be kept are marked as pruned.
Returned information
The number of rules that are kept after the pruning process as a result set. The model tables are
modified accordingly.
Example
CALL IDAX.PRUNE_ASSOCRULES('model=retail_assoc, minlen=3');