Ignore:
Timestamp:
12/05/13 06:56:59 (5 months ago)
Author:
blaz <blaz.zupan@…>
Branch:
default
Message:

Update of documentation of Data Table widget.

File:
1 edited

Legend:

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

    r11778 r11790  
    77   :alt: Data Table icon 
    88 
     9Displays attribute-value data in a spreadsheet. 
     10 
    911Signals 
    1012------- 
    1113 
    1214Inputs: 
    13     - Examples (ExampleTable) 
     15    - Data 
    1416        Attribute-valued data set. 
    1517 
    1618Outputs: 
    17     - Selected Examples (Example Table) 
    18         Selected data instalces 
     19    - Selected Data 
     20        Selected data instances. 
    1921 
    2022Description 
    2123----------- 
    2224 
    23 Data Table widget takes one or more data sets on its input, and presents 
    24 them in a spreadsheet format. Widget supports sorting by attribute 
    25 values (click on the attribute name in the header row). 
     25Data Table widget receives one or more data sets on its input and presents 
     26them in a spreadsheet format. Data instances may be sorted by attribute 
     27values. Widget also supports manual selection of data instances. 
    2628 
    27 Examples 
    28 -------- 
     29.. image:: images/DataTable-stamped.png 
     30   :alt: Data table with Iris data set 
     31 
     321. The name of the data set (e.g., inherited from the name of the 
     33   input data file) with a table of data instances (in rows) 
     34   and their attribute values (columns). In the example shown the data set 
     35   is sorted by the attribute "sepal length". 
     36#. Info on current data set size and the number and types of attributes. 
     37#. Meta attributes are not included in this example data set, 
     38   the corresponding option is dimmed. 
     39   Use "Restore Order" button to reorder data instance after attribute-based 
     40   sorting. 
     41#. Values of continuous attributes can be visualized with bars. 
     42#. Data instances (rows) can be selected and sent to the widget's output 
     43   channel. 
     44#. Adds an entry with the entire data table to the current report. 
     45 
     46Example 
     47------- 
    2948 
    3049We used two :ref:`File` widgets, read the iris and glass data set (provided in 
    3150Orange distribution), and send them to the Data Table widget. 
    3251 
    33 .. image:: images/DataTable_schema.png 
     52.. image:: images/DataTable-Schema.png 
    3453   :alt: Example data table schema 
    3554 
    36 A snapshot of the widget under these settings is shown below. 
     55Selected data instances in the first Data Table are passed to the second 
     56Data Table. Notice that we can select which data set to view (iris or zoo); 
     57change from one data set to another alters the communicated 
     58selection of the data instances if "Commit on any change is selected". 
    3759 
    38 .. image:: images/DataTable.png 
     60.. image:: images/DataTable-Example.png 
    3961   :alt: Data Table widget example 
Note: See TracChangeset for help on using the changeset viewer.