Ignore:
Timestamp:
12/14/13 04:16:33 (4 months ago)
Author:
blaz <blaz.zupan@…>
Branch:
default
Message:

Updated documentation for the Save widget.

File:
1 edited

Legend:

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

    r11778 r11812  
    55 
    66.. image:: ../../../../Orange/OrangeWidgets/Data/icons/Save.svg 
     7   :alt: Save widget icon 
     8   :class: widget-category-data widget-icon 
    79 
    810Saves data to a file. 
     
    1214 
    1315Inputs: 
    14    - Examples (ExampleTable) 
    15       Attribute-valued data set. 
     16   - :obj:`Data` 
     17        Attribute-valued data set. 
    1618 
    1719Outputs: 
     
    2123----------- 
    2224 
    23 .. image:: images/Save.png 
     25Save widget considers a data set provided on the input channel and 
     26saves it to a data file with the specified name. The widget remembers 
     27a history of the most recent file names. It can save into 
     28tab-delimited and comma-separated files, as well as the C4.5's format 
     29and Weka's .arrf files. 
    2430 
    25 Takes a data set provided at the input channel and saves it to a 
    26 data file with the specified name. The widget remembers a history of the most recent file names. 
    27 It can save into tab-delimited and comma-separated files, as well as the 
    28 C4.5's format and Weka's .arrf files. 
     31By design, the widget does not save the data every time it receives a 
     32new signal on the input as this would constantly (and, mostly, 
     33inadvertently) overwrite the file. Instead, the data is saved only 
     34after a new file name is set or the user pushes :obj:`Save` button. 
    2935 
    30 The widget does not save the data every time it receives a new signal on 
    31 the input as this would constantly (and, mostly, inadvertently) overwrite 
    32 the file. Instead the data is saved after a new file name is set or the 
    33 user pushes :obj:`Save current data`. 
     36.. image:: images/Save-stamped.png 
     37   :alt: File widget with loaded Iris data set 
     38   :align: right 
     39 
     40.. rst-class:: stamp-list 
     41 
     42    1. Selected from the file names and locations from the past 
     43       saves. 
     44    #. Specify a new data file to save to. 
     45    #. Save the data to a chosen data file. 
     46 
     47.. container:: clearer 
     48 
     49    .. image :: images/spacer.png 
     50 
    3451 
    3552Example 
    3653------- 
    3754 
    38 The schema below can be used to train the naive Bayesian classifier on the data loaded 
    39 from a file, use the classifier on data from another file and save the misclassified examples 
    40 (or the correctly classified, depending on what we select in the Confusion Matrix) into a file. 
     55In the workflow below we load the data into a :ref:`Scatter Plot` 
     56widget, where we select a subset of the data instances and push them 
     57to Save widget to store them in a data file. 
    4158 
    4259.. image:: images/Save-Example.png 
Note: See TracChangeset for help on using the changeset viewer.