Changeset 11812:3912cba8d2a6 in orange


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

Updated documentation for the Save widget.

Files:
2 added
5 edited

Legend:

Unmodified
Added
Removed
  • Orange/OrangeWidgets/Data/OWSave.py

    r11748 r11812  
    5858 
    5959        fbox = OWGUI.widgetBox(self.controlArea, "Save") 
    60         self.save = OWGUI.button(fbox, self, "Save current data", callback = self.saveFile, default=True) 
     60        self.save = OWGUI.button(fbox, self, "Save", callback = self.saveFile, default=True) 
    6161        self.save.setDisabled(1) 
    6262         
  • docs/widgets/rst/data/file.rst

    r11810 r11812  
    2323.. _my-reference-label: 
    2424 
    25 Section to cross-reference 
    26 -------------------------- 
    27  
    28 This is the text of the section. 
    29  
    30 It refers to the section itself, see :ref:`my-reference-label`. 
    31  
    32  
    3325Description 
    3426----------- 
     
    3628File widget reads the input data file (data table with data instances) 
    3729and sends the data set to its output channel. It maintains 
    38 a history of most recently opened files. For convenience, the history also includes 
    39 a directory with the sample data sets that come pre-installed with Orange. 
     30a history of most recently opened files. For convenience, the history also 
     31includes a directory with the sample data sets that come 
     32pre-installed with Orange. 
    4033 
    4134The widget reads data from simple tab-delimited or comma-separated files, 
     
    7972    .. image :: images/spacer.png 
    8073 
    81 Tab-delimited data file can include user defined symbols for undefined values. The symbols for 
    82 "don't care" and "don't know" values can be specified in the corresponding edit lines.  
    83 The default values for "don't know" and "don't care" depend upon format. Most users will  
    84 use tab-delimited files: keep the field empty or put a question mark in there and that's  
    85 it. Most algorithms do not differ between don't know and don't care values, so consider  
    86 them both to mean undefined. 
     74Tab-delimited data file can include user defined symbols for undefined 
     75values. The symbols for "don't care" and "don't know" values can be 
     76specified in the corresponding edit lines.  The default values for 
     77"don't know" and "don't care" depend upon format. Most users will use 
     78tab-delimited files: keep the field empty or put a question mark in 
     79there and that's it. Most algorithms do not differ between don't know 
     80and don't care values, so consider them both to mean undefined. 
    8781 
    88 Orange will usually treat the attributes with the same name 
    89 but appearing in different files as the same attribute, so a classifier which uses the  
    90 attribute "petal length" from the first will use the attribute of the same name from  
    91 the second. In cases when attributes from different files just accidentally bear different  
    92 names, one can instruct Orange to either always construct new attribute or construct them when  
    93 they differ in their domains. Use the options on dealing with new attributes 
    94 with great care (if at all). 
     82Orange will usually treat the attributes with the same name but 
     83appearing in different files as the same attribute, so a classifier 
     84which uses the attribute "petal length" from the first will use the 
     85attribute of the same name from the second. In cases when attributes 
     86from different files just accidentally bear different names, one can 
     87instruct Orange to either always construct new attribute or construct 
     88them when they differ in their domains. Use the options on dealing 
     89with new attributes with great care (if at all). 
    9590 
    9691Example 
    9792------- 
    9893 
    99 Most Orange workflows would probably start with the File widget. In the schema below, 
    100 the widget is used to read the data that is sent to both :ref:`Data Table` widget and 
    101 to widget that displays :ref:`Attribute Statistics`. 
     94Most Orange workflows would probably start with the File widget. In 
     95the schema below, the widget is used to read the data that is sent to 
     96both :ref:`Data Table` widget and to widget that displays 
     97:ref:`Attribute Statistics`. 
    10298 
    10399.. image:: images/File_schema.png 
  • 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.