Blaz Zupan  committed 3a747e2

Updated documentation on Select Data widget.

  • Participants
  • Parent commits d6770df
  • Branches default

Comments (0)

Files changed (5)

File docs/widgets/rst/data/images/SelectData-Example.png

New image

File docs/widgets/rst/data/images/SelectData-stamped.png

New image

File docs/widgets/rst/data/images/SelectData-tags.txt

+0	174	28
+1	75	260
+2	163	260
+3	245	260
+4	329	260
+5	422	260
+6	153	299
+7	70	375
+8	60	592
+9	208	592

File docs/widgets/rst/data/images/SelectData.png

Old image
New image

File docs/widgets/rst/data/selectdata.rst

 .. image:: ../../../../Orange/OrangeWidgets/Data/icons/SelectData.svg
+   :class: widget-category-data widget-icon
-Selects instances from input data sets based on conditions on attributes.
+Selects data instances based on conditions over data features.
-   - Examples (ExampleTable)
+   - Data
       Attribute-valued data set.
-   - Matching Examples (ExampleTable)
-      Attribute-valued data set composed from instances from input data set
-      that match user-defined condition.
-   - Non-Matching Examples (ExampleTable)
-      Data instances from input data set that do not match the user-defined
-      condition.
+   - Matching Data
+      Data instances that match the conditions.
+   - Non-Matching Data
+      Data instances that do not match the conditions.
 This widget allows the user to select a subset of the data from the
 input data set based on the condition defined over a set of data's
 attributes. Data instances that match the selection rule are placed on
-the output channel.
+the output Matching Data channel.
-.. image:: images/SelectData.png
-   :alt: Select Data
-Condition is presented in disjunctive normal form, that is, as
+Criteria for data selection are presented in disjunctive normal form, as
 collection of conjuncted terms (AND operator) with optional disjunction
 (OR operator). In other words, if condition does not include a
 disjunction (OR line in the condition) than selected items are those
 condition term. Operators are different for discrete, continuous and
 string attributes.
-After the terms is defined, it is included in the condition by
-pressing :obj:`Add button`.
+.. image:: images/SelectData-stamped.png
+   :alt: Select Data
-To update or change the condition term, select the corresponding
-line in the :obj:`Data Selection Criteria`, change the term's definition
-(:obj:`Attribute`/:obj:`Operator`/:obj:`Values`) and press :obj:`Update`.
+.. rst-class:: stamp-list
+   1. Choose an attribute, operator and related value to construct the
+      condition.
+   #. Add a new condition to the list of conditions. The new condition will
+      appear in the Data Selection Criteria box.
+   #. Modify a selected condition from the list.
+   #. Remove the selected condition from the list.
+   #. Insert an OR operator to the list of conditions.
+   #. Rearrange the order of conditions in the list. If there is not OR
+      operator, the order would not have any effect on data selection.
+   #. List with conditions that are currently applied to the data.
+   #. Number of data items matching the condition.
+   #. Information on the input data set.
+   #. Information on the data set of instances that match the condition.
 Notice that any change in composition of the condition will trigger
 updates in information pane that displays the number of data instances
 Data set composed of instances that match the defined condition is
-placed on the output channel. If :obj:`Update on any change` is selected,
+placed on the output channel. If :obj:`Commit on change` is selected,
 than the output is updated on any change in the composition of the
 condition or any of its terms.
-Below is a simple example that loads the imports-85 data set and
-compares the lengths of the car in a complete data set and data set
-where some more expensive brands are selected.
+In a toy example below we used the car data from imports-85 data set and
+compared the prices of all the cars in the data set to those of BMW and
-.. image:: images/SelectData-Example-S.gif
-   :alt: Schema with Data Sampler
+.. image:: images/SelectData-Example.png
+   :alt: A workflow with Data Sampler