Changeset 11785:f21218ba8f91 in orange


Ignore:
Timestamp:
12/04/13 06:26:45 (4 months ago)
Author:
blaz <blaz.zupan@…>
Branch:
default
Message:

Updated documentation for File widget (use of stamper.py to render images).

Files:
6 added
4 edited

Legend:

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

    r11748 r11785  
    306306                return 
    307307 
    308         self.infoa.setText('%d example(s), ' % len(data) + 
    309                            '%d attribute(s), ' % len(data.domain.attributes) + 
    310                            '%d meta attribute(s).' % len(data.domain.getmetas())) 
     308        self.infoa.setText("%d data instance%s, " % 
     309                           (len(data), 's' if len(data) > 1 else '') + 
     310                           "%d feature%s, " % 
     311                           (len(data.domain.attributes), 
     312                            's' if len(data.domain.attributes) > 1 else '') + 
     313                           '%d meta attribute%s.' % 
     314                           (len(data.domain.getmetas()), 
     315                            's' if len(data.domain.getmetas()) > 1 else '')) 
    311316        cl = data.domain.class_var 
    312317        if cl is not None: 
     
    315320            elif isinstance(cl, Orange.feature.Discrete): 
    316321                self.infob.setText( 
    317                     'Classification; Discrete class with %d value(s).' % 
    318                     len(cl.values) 
     322                    'Classification; Discrete class with %d value%s.' % 
     323                    (len(cl.values), 's' if len(cl.values) > 1 else '') 
    319324                ) 
    320325            else: 
  • docs/widgets/rst/data/file.rst

    r11778 r11785  
    1414 
    1515Outputs: 
    16    - Examples (ExampleTable) 
    17         Attribute-valued data set read from the input file. 
     16   - Data 
     17         Attribute-valued data set read from the input file. 
    1818 
    1919Description 
    2020----------- 
    2121 
    22 .. image:: images/File.png 
    23    :alt: File widget with loaded ionosphere.tab data set 
    24     
    25 This is the widget you will probably use in every schema. It reads the input data file  
     22This is the widget you will probably use in every schema. It reads the input data file 
    2623(data table with examples) and sends the data set to the output channel. It maintains 
    27 a history of most recently used data files. For convenience, the history also includes  
     24a history of most recently used data files. For convenience, the history also includes 
    2825a directory with the sample data sets that come with Orange. 
    2926 
    30 To browse for a data file press .... Reload button reloads the file. 
     27File can read data from simple tab-delimited or comma-separated files, as well as 
     28files Weka's .arrf format. 
    3129 
    32 The widget can read data from simple tab-delimited or comma-separated files, as well as 
    33 files in C4.5 format and Weka's .arrf files. 
     30.. image:: images/File-stamped.png 
     31   :alt: File widget with loaded Iris data set 
     32   :align: right 
    3433 
    35 The info box at the bottom of the widget displays information on the number of examples,  
    36 attributes and meta attributes, and information on class variable (if defined in a file). 
     341. Browse for a data file. 
     35#. Browse through previously opened data files, or load any of the sample data 
     36   files. 
     37#. Reloads currently selected data file. 
     38#. Information on loaded data set (data set size, number and types of 
     39   data features). 
     40#. Opens a sub-window with advanced settings. 
     41#. Adds a report on data set info (size, features). 
    3742 
    38 The controls in between are for more advanced users. 
     43.. container:: clearer 
    3944 
    40 Tab-delimited file can have user defined symbols for undefined values. The symbols for  
     45    .. image :: images/spacer.png 
     46 
     47Advanced Options 
     48---------------- 
     49 
     50.. image:: images/File-Advanced-stamped.png 
     51   :alt: Advanced options of File widget 
     52   :align: right 
     53 
     541. Symbol for don't care data entry. 
     55#. Symbol for don't know data entry. 
     56#. Settings for treatment of feature names in the feature space of Orange. 
     57 
     58.. container:: clearer 
     59 
     60    .. image :: images/spacer.png 
     61 
     62Tab-delimited data file can include user defined symbols for undefined values. The symbols for 
    4163"don't care" and "don't know" values can be specified in the corresponding edit lines.  
    4264The default values for "don't know" and "don't care" depend upon format. Most users will  
     
    4567them both to mean undefined. 
    4668 
    47 The part which most will probably neither understand nor need is related to construction  
    48 of new attributes. It becomes important when multiple data sets are loaded, usually with  
    49 multiple File widgets. A typical example is loading separate training and testing data  
    50 from two files. In this case Orange will usually treat the attributes with the same name  
     69Orange will usually treat the attributes with the same name 
    5170but appearing in different files as the same attribute, so a classifier which uses the  
    5271attribute "petal length" from the first will use the attribute of the same name from  
    5372the second. In cases when attributes from different files just accidentally bear different  
    5473names, one can instruct Orange to either always construct new attribute or construct them when  
    55 they differ in their domains. Use this option with great care (if at all). 
     74they differ in their domains. Use the options on dealing with new attributes 
     75with great care (if at all). 
    5676 
    57 Examples 
    58 -------- 
     77Example 
     78------- 
    5979 
    60 Any of your schemas should probably start with the :ref:`File` widget. In the schema below, 
    61 the widget is used to read the data that is then sent to both :ref:`Data Table` widget and  
     80Most Orange workflows would probably start with the :ref:`File` widget. In the schema below, 
     81the widget is used to read the data that is sent to both :ref:`Data Table` widget and 
    6282to widget that displays :ref:`Attribute Statistics`. 
    6383 
Note: See TracChangeset for help on using the changeset viewer.