source: orange/docs/widgets/rst/data/save.rst @ 11812:3912cba8d2a6

Revision 11812:3912cba8d2a6, 1.4 KB checked in by blaz <blaz.zupan@…>, 4 months ago (diff)

Updated documentation for the Save widget.

Line 
1.. _Save:
2
3Save
4====
5
6.. image:: ../../../../Orange/OrangeWidgets/Data/icons/Save.svg
7   :alt: Save widget icon
8   :class: widget-category-data widget-icon
9
10Saves data to a file.
11
12Signals
13-------
14
15Inputs:
16   - :obj:`Data`
17        Attribute-valued data set.
18
19Outputs:
20   - (None)
21
22Description
23-----------
24
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.
30
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.
35
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
51
52Example
53-------
54
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.
58
59.. image:: images/Save-Example.png
60   :alt: Schema with Save widget
Note: See TracBrowser for help on using the repository browser.