Changeset 11807:3a747e269e51 in orange


Ignore:
Timestamp:
12/13/13 00:29:39 (4 months ago)
Author:
blaz <blaz.zupan@…>
Branch:
default
Message:

Updated documentation on Select Data widget.

Location:
docs/widgets/rst/data
Files:
3 added
2 edited

Legend:

Unmodified
Added
Removed
  • docs/widgets/rst/data/selectdata.rst

    r11778 r11807  
    55 
    66.. image:: ../../../../Orange/OrangeWidgets/Data/icons/SelectData.svg 
     7   :class: widget-category-data widget-icon 
    78 
    8 Selects instances from input data sets based on conditions on attributes. 
     9Selects data instances based on conditions over data features. 
    910 
    1011Signals 
     
    1213 
    1314Inputs: 
    14    - Examples (ExampleTable) 
     15   - Data 
    1516      Attribute-valued data set. 
    1617 
    1718 
    1819Outputs: 
    19    - Matching Examples (ExampleTable) 
    20       Attribute-valued data set composed from instances from input data set 
    21       that match user-defined condition. 
    22    - Non-Matching Examples (ExampleTable) 
    23       Data instances from input data set that do not match the user-defined 
    24       condition. 
    25  
     20   - Matching Data 
     21      Data instances that match the conditions. 
     22   - Non-Matching Data 
     23      Data instances that do not match the conditions. 
    2624 
    2725Description 
     
    3129input data set based on the condition defined over a set of data's 
    3230attributes. Data instances that match the selection rule are placed on 
    33 the output channel. 
     31the output Matching Data channel. 
    3432 
    35 .. image:: images/SelectData.png 
    36    :alt: Select Data 
    37  
    38 Condition is presented in disjunctive normal form, that is, as 
     33Criteria for data selection are presented in disjunctive normal form, as 
    3934collection of conjuncted terms (AND operator) with optional disjunction 
    4035(OR operator). In other words, if condition does not include a 
     
    4843string attributes. 
    4944 
    50 After the terms is defined, it is included in the condition by 
    51 pressing :obj:`Add button`. 
     45.. image:: images/SelectData-stamped.png 
     46   :alt: Select Data 
    5247 
    53 To update or change the condition term, select the corresponding 
    54 line in the :obj:`Data Selection Criteria`, change the term's definition 
    55 (:obj:`Attribute`/:obj:`Operator`/:obj:`Values`) and press :obj:`Update`. 
     48.. rst-class:: stamp-list 
     49 
     50   1. Choose an attribute, operator and related value to construct the 
     51      condition. 
     52   #. Add a new condition to the list of conditions. The new condition will 
     53      appear in the Data Selection Criteria box. 
     54   #. Modify a selected condition from the list. 
     55   #. Remove the selected condition from the list. 
     56   #. Insert an OR operator to the list of conditions. 
     57   #. Rearrange the order of conditions in the list. If there is not OR 
     58      operator, the order would not have any effect on data selection. 
     59   #. List with conditions that are currently applied to the data. 
     60   #. Number of data items matching the condition. 
     61   #. Information on the input data set. 
     62   #. Information on the data set of instances that match the condition. 
    5663 
    5764Notice that any change in composition of the condition will trigger 
     
    6269 
    6370Data set composed of instances that match the defined condition is 
    64 placed on the output channel. If :obj:`Update on any change` is selected, 
     71placed on the output channel. If :obj:`Commit on change` is selected, 
    6572than the output is updated on any change in the composition of the 
    6673condition or any of its terms. 
    6774 
    68 Examples 
    69 -------- 
     75Example 
     76------- 
    7077 
    71 Below is a simple example that loads the imports-85 data set and 
    72 compares the lengths of the car in a complete data set and data set 
    73 where some more expensive brands are selected. 
     78In a toy example below we used the car data from imports-85 data set and 
     79compared the prices of all the cars in the data set to those of BMW and 
     80Marcedes-Benz. 
    7481 
    75 .. image:: images/SelectData-Example-S.gif 
    76    :alt: Schema with Data Sampler 
     82.. image:: images/SelectData-Example.png 
     83   :alt: A workflow with Data Sampler 
Note: See TracChangeset for help on using the changeset viewer.