source: orange/docs/widgets/rst/associate/associationrulesfilter.rst @ 11778:ecd4beec2099

Revision 11778:ecd4beec2099, 2.6 KB checked in by Ales Erjavec <ales.erjavec@…>, 5 months ago (diff)

Use new SVG icons in the widget documentation.

Line 
1.. _Association Rules Filter:
2
3Association Rules Filter
4========================
5
6.. image:: ../../../../Orange/OrangeWidgets/Associate/icons/AssociationRulesFilter.svg
7
8A widget for printing out the rules and for their manual exploration and
9selection.
10
11Signals
12-------
13
14Inputs:
15   - Association Rules
16      A list of rules
17
18
19Outputs:
20   - Association Rules
21      Selected rules
22
23
24
25Description
26-----------
27
28This widget can be used for three purposes:
29   - graphically showing the confidence and support of the induced rules
30   - selecting a subset of rules based on their confidence and support
31   - listing the induced rules and the corresponding measures of quality
32
33The columns of the grid on the left hand side of the widget represent
34different supports and the rows represents confidences. The scale is given
35above the grid: for the case in this snapshot, support goes from 28% to 75%
36and the confidence ranges from 29% to 100%. Each cell is colored according
37to the number of rules with that particular support and confidence - the
38darker the cell, the more rules are inside it.
39
40You can select a part of the grid. In the snapshot we selected the rules
41with supports between 36% and 66% and confidences from 33% to 82%.
42
43When the widget receives certain data, it shows the area containing all
44the rules. You can :obj:`Zoom` in to enlarge the selected part, push
45:obj:`Show All` to see the region with the rules again, or :obj:`No Zoom`
46to see the region with support and confidence from 0 to 1. :obj:`Unselect`
47removes the selection.
48
49If nothing is selected, the widget outputs all rules.
50
51On the right hand side of the widget there is a list of the selected rules.
52The checkboxes above can be used to select the measures of rule quality that
53we are interested in. Let L, R and B be the number of examples that fit the
54left, the right and both sides of the rule, respectively, and N the total
55number of examples in the data set. The measures are then defined as follows
56
57   - support = B / N
58   - confidence = B / L
59   - coverage = L / N
60   - strength = R / L
61   - lift = N * B / (L * R)
62   - leverage = N * B - L * R
63
64
65
66With the buttons below you can :obj:`Save Rules` into a tab-delimited file
67or :obj:`Send Rules` to the widget connected to the output. The latter is
68only enabled if :obj:`Send rules automatically` is unchecked. When it is
69checked, the rules are put on the widget's output automatically at every
70selection change.
71
72Examples
73--------
74
75This widget is used with the :ref:`Association Rules` and maybe with a
76tree-like :ref:`Association Rules Explorer` The typical schema is shown below.
77
78.. image:: images/AssociationRules-Schema.png
79   :alt: Association Rules
Note: See TracBrowser for help on using the repository browser.