source: orange/docs/widgets/rst/data/datatable.rst @ 11790:9f217fd8d576

Revision 11790:9f217fd8d576, 1.9 KB checked in by blaz <blaz.zupan@…>, 4 months ago (diff)

Update of documentation of Data Table widget.

Line 
1.. _Data Table:
2
3Data Table
4==========
5
6.. image:: ../../../../Orange/OrangeWidgets/Data/icons/DataTable.svg
7   :alt: Data Table icon
8
9Displays attribute-value data in a spreadsheet.
10
11Signals
12-------
13
14Inputs:
15    - Data
16        Attribute-valued data set.
17
18Outputs:
19    - Selected Data
20        Selected data instances.
21
22Description
23-----------
24
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.
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-------
48
49We used two :ref:`File` widgets, read the iris and glass data set (provided in
50Orange distribution), and send them to the Data Table widget.
51
52.. image:: images/DataTable-Schema.png
53   :alt: Example data table schema
54
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".
59
60.. image:: images/DataTable-Example.png
61   :alt: Data Table widget example
Note: See TracBrowser for help on using the repository browser.