source: orange/docs/widgets/rst/index.rst @ 11797:840029d005bb

Revision 11797:840029d005bb, 16.7 KB checked in by blaz <blaz.zupan@…>, 4 months ago (diff)

Enabled custom documentation enumeration (stamper CSS style).

Line 
1##############
2Orange Widgets
3##############
4
5Orange widgets are building blocks of data analysis workflows that are
6assembled in Orange's visual programming environment.
7
8.. image:: images/simple-workflow.png
9    :alt: Orange Workflow
10
11Widgets are grouped into classes according to their function. A typical
12workflow may mix widgets for data input and filtering, visualization,
13and predictive data mining.
14
15Data
16----
17
18
19.. list-table::
20    :class: widget-catalog-table widget-category-data
21    :widths: 1 1 1
22   
23    * - |File_icon| :ref:`File`
24      - |DataTable_icon| :ref:`Data Table`
25      - |SelectAttributes_icon| :ref:`Select Attributes`
26    * - |Rank_icon| :ref:`Rank`
27      - |PurgeDomain_icon| :ref:`Purge Domain`
28      - |MergeData_icon| :ref:`Merge Data`
29    * - |Concat_icon| :ref:`Concatenate`
30      - |DataSampler_icon| :ref:`Data Sampler`
31      - |SelectData_icon| :ref:`Select Data`
32    * - |Save_icon| :ref:`Save`
33      - |Discretize_icon| :ref:`Discretize`
34      - |Cont_icon| :ref:`Continuize`
35    * - |Impute_icon| :ref:`Impute`
36      - |Outliers_icon| :ref:`Outliers`
37      - |EditDomain_icon| :ref:`Edit Domain`
38    * - |PythonScript_icon| :ref:`Python Script`
39      -
40      -
41
42.. |File_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/File.svg
43    :alt: File
44    :width: 40
45    :height: 40
46
47.. |DataTable_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataTable.svg
48    :alt: Data Table
49    :width: 40
50    :height: 40
51   
52.. |SelectAttributes_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/SelectAttributes.svg
53    :alt: Select Attributes
54    :width: 40
55    :height: 40
56   
57.. |Rank_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Rank.svg
58    :alt: Rank
59    :width: 40
60    :height: 40
61   
62.. |PurgeDomain_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/PurgeDomain.svg
63    :alt: Purge Domain
64    :width: 40
65    :height: 40
66   
67.. |MergeData_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/MergeData.svg
68    :alt: Merge Data
69    :width: 40
70    :height: 40
71
72.. |Concat_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Concatenate.svg
73    :alt: Merge Data
74    :width: 40
75    :height: 40
76
77.. |DataSampler_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/DataSampler.svg
78    :alt: Merge Data
79    :width: 40
80    :height: 40
81
82.. |SelectData_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/SelectData.svg
83    :alt: Merge Data
84    :width: 40
85    :height: 40
86
87.. |Save_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Save.svg
88    :alt: Merge Data
89    :width: 40
90    :height: 40
91
92.. |Discretize_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Discretize.svg
93    :alt: Merge Data
94    :width: 40
95    :height: 40
96
97.. |Cont_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Continuize.svg
98    :alt: Merge Data
99    :width: 40
100    :height: 40
101   
102.. |Impute_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Impute.svg
103    :alt: Merge Data
104    :width: 40
105    :height: 40
106   
107.. |Outliers_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/Outliers.svg
108    :alt: Merge Data
109    :width: 40
110    :height: 40
111
112.. |EditDomain_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/EditDomain.svg
113   :alt: Edit Domain
114   :width: 40
115   :height: 40
116
117.. |PythonScript_icon| image:: ../../../Orange/OrangeWidgets/Data/icons/PythonScript.svg
118   :alt: Edit Domain
119   :width: 40
120   :height: 40
121
122
123Visualize
124---------
125
126.. list-table::
127    :class: widget-catalog-table widget-category-visualize
128    :widths: 1 1 1
129   
130    * - |Distributions_icon| :ref:`Distributions`
131      - |ScatterPlot_icon| :ref:`Scatter Plot`
132      - |AttributeStatistics_icon| :ref:`Attribute Statistics`
133    * - |LinearProjection_icon| :ref:`Linear Projection`
134      - |Radviz_icon| :ref:`Radviz`
135      - |Polyviz_icon| :ref:`Polyviz`
136    * - |ParallelCoords_icon| :ref:`Parallel Coordinates`
137      - |SurveyPlot_icon| :ref:`Survey Plot`
138      - |MosaicDisplay_icon| :ref:`Mosaic Display`
139    * - |SieveDiagram_icon| :ref:`Sieve Diagram`
140      - |SieveMultigram_icon| `Sieve Multigram`
141      -
142
143.. |Distributions_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Distribution.svg
144    :alt: Distributions
145    :width: 40
146    :height: 40
147   
148.. |ScatterPlot_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/ScatterPlot.svg
149    :alt: Scatter Plot
150    :width: 40
151    :height: 40
152   
153.. |AttributeStatistics_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/AttributeStatistics.svg
154    :alt: AttributeStatistics
155    :width: 40
156    :height: 40
157   
158.. |LinearProjection_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/LinearProjection.svg
159    :alt: Linear Projection
160    :width: 40
161    :height: 40
162   
163.. |Radviz_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Radviz.svg
164    :alt: Rad Viz
165    :width: 40
166    :height: 40
167   
168.. |Polyviz_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/Polyviz.svg
169    :alt: Poly Viz
170    :width: 40
171    :height: 40
172   
173.. |ParallelCoords_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/ParallelCoordinates.svg
174    :alt: Parallel Coordinates
175    :width: 40
176    :height: 40
177
178.. |SurveyPlot_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SurveyPlot.svg
179    :alt: Survey Plot
180    :width: 40
181    :height: 40
182   
183.. |MosaicDisplay_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/MosaicDisplay.svg
184    :alt: Mosaic Display
185    :width: 40
186    :height: 40
187   
188.. |SieveDiagram_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SieveDiagram.svg
189    :alt: Sieve Diagram
190    :width: 40
191    :height: 40
192   
193.. |SieveMultigram_icon| image:: ../../../Orange/OrangeWidgets/Visualize/icons/SieveMultigram.svg
194    :alt: Sieve Multigram
195    :width: 40
196    :height: 40
197
198
199Classify
200--------
201   
202.. list-table::
203    :class: widget-catalog-table widget-category-classify
204    :widths: 1 1 1
205   
206    * - |NaiveBayes_icon| :ref:`Naive Bayes`
207      - |SVM_icon| :ref:`SVM`
208      - |LogReg_icon| :ref:`Logistic Regression`
209    * - |Majority_icon| :ref:`Majority`
210      - |ClassificationTree_icon| :ref:`Classification Tree`
211      - |ClassificationTreeGraph_icon| :ref:`Classification Tree Graph`
212    * - |ClsTreeViewer_icon| :ref:`Classification Tree Viewer`
213      - |CN2Rules_icon| :ref:`CN2 Rules`
214      - |CN2RulesViewer_icon| :ref:`CN2 Rules Viewer`
215    * - |kNN_icon| :ref:`k-Nearest Neighbours`
216      - |Nomogram_icon| :ref:`Nomogram`
217      - |RandomForest_icon| :ref:`Random Forest`
218    * - |C4.5_icon| :ref:`C4.5`
219      - |ITreeBuilder_icon| :ref:`Interactive Tree Builder`
220      -
221
222.. |NaiveBayes_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/NaiveBayes.svg
223    :alt: Naive Bayes
224    :width: 40
225    :height: 40
226
227.. |SVM_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/SVM.svg
228    :alt: Support Vector Machines
229    :width: 40
230    :height: 40
231
232.. |LogReg_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/LogisticRegression.svg
233    :alt: Logistic Regression
234    :width: 40
235    :height: 40
236
237.. |Majority_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/Majority.svg
238    :alt: Majority
239    :width: 40
240    :height: 40
241
242.. |ClassificationTree_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTree.svg
243    :alt: Classification Tree
244    :width: 40
245    :height: 40
246
247.. |ClassificationTreeGraph_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTreeGraph.svg
248    :alt: Classification Tree Graph
249    :width: 40
250    :height: 40
251
252.. |ClsTreeViewer_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/ClassificationTreeViewer.svg
253    :alt: Classification Tree Viewer
254    :width: 40
255    :height: 40
256
257.. |CN2Rules_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/CN2.svg
258    :alt: CN2 Rules
259    :width: 40
260    :height: 40
261
262.. |CN2RulesViewer_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/CN2RulesViewer.svg
263    :alt: CN2 Rules Viewer
264    :width: 40
265    :height: 40
266
267.. |kNN_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/kNearestNeighbours.svg
268    :alt: k-Nearest Neighbours
269    :width: 40
270    :height: 40
271
272.. |Nomogram_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/Nomogram.svg
273    :alt: Nomogram
274    :width: 40
275    :height: 40
276
277.. |RandomForest_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/RandomForest.svg
278    :alt: Random Forest
279    :width: 40
280    :height: 40
281
282.. |C4.5_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/C4.5.svg
283    :alt: C4.5
284    :width: 40
285    :height: 40
286
287.. |ITreeBuilder_icon| image:: ../../../Orange/OrangeWidgets/Classify/icons/InteractiveTreeBuilder.svg
288    :alt: Interactive Tree Builder
289    :width: 40
290    :height: 40
291
292
293Regression
294----------
295
296.. list-table::
297    :widths: 1 1 1
298    :class: widget-catalog-table widget-category-regression
299   
300    * - |Mean_icon| :ref:`Mean`
301      - |LinearRegression_icon| :ref:`Linear Regression`
302      - |RegressionTree_icon| :ref:`Regression Tree`
303    * - |RegressionTreeGraph_icon| :ref:`Regression Tree Graph`
304      - |Pade_icon| :ref:`Pade`
305      -
306
307
308.. |Mean_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/Mean.svg
309    :alt: Mean
310    :width: 40
311    :height: 40
312
313.. |LinearRegression_icon| image:: ../../../Orange/OrangeWidgets//Regression/icons/LinearRegression.svg
314    :alt: Linear Regression
315    :width: 40
316    :height: 40
317
318.. |RegressionTree_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/RegressionTree.svg
319    :alt: Regression Tree
320    :width: 40
321    :height: 40
322
323.. |RegressionTreeGraph_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/RegressionTreeGraph.svg
324    :alt: Regression Tree Graph
325    :width: 40
326    :height: 40
327
328.. |Pade_icon| image:: ../../../Orange/OrangeWidgets/Regression/icons/Pade.svg
329    :alt: Pade
330    :width: 40
331    :height: 40
332
333
334Evaluate
335--------
336
337.. list-table::
338    :widths: 1 1 1
339    :class: widget-catalog-table widget-category-evaluate
340   
341    * - |ConfusionMatrix_icon| :ref:`Confusion Matrix`
342      - |ROCAnalysis_icon| :ref:`ROC Analysis`
343      - |LiftCurve_icon| :ref:`Lift Curve`
344    * - |CalibrationPlot_icon| :ref:`Calibration Plot`
345      - |TestLearners_icon| :ref:`Test Learners`
346      - |Predictions_icon| :ref:`Predictions`
347
348
349.. |ConfusionMatrix_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/ConfusionMatrix.svg
350    :alt: Confusion Matrix
351    :width: 40
352    :height: 40
353
354.. |ROCAnalysis_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/ROCAnalysis.svg
355    :alt: Pade
356    :width: 40
357    :height: 40
358
359.. |LiftCurve_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/LiftCurve.svg
360    :alt: Lift Curve
361    :width: 40
362    :height: 40
363
364.. |CalibrationPlot_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/CalibrationPlot.svg
365    :alt: Calibration Plot
366    :width: 40
367    :height: 40
368
369.. |TestLearners_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/TestLearners1.svg
370    :alt: Test Learners
371    :width: 40
372    :height: 40
373
374.. |Predictions_icon| image:: ../../../Orange/OrangeWidgets/Evaluate/icons/Predictions.svg
375    :alt: Predictions
376    :width: 40
377    :height: 40
378
379
380Associate
381---------
382
383.. list-table::
384    :widths: 1 1 1
385    :class: widget-catalog-table widget-category-associate
386   
387    * - |AssociationRules_icon| :ref:`Association Rules`
388      - |AssociationRulesFilter_icon| :ref:`Association Rules Filter`
389      - |AssociationRulesExplorer_icon| :ref:`Association Rules Explorer`
390    * - |ItemSets_icon| `Item Sets`
391      - |ItemSetsExplorer_icon| `Item Sets Explorer`
392      -
393
394.. |AssociationRules_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRules.svg
395    :alt: Association Rules
396    :width: 40
397    :height: 40
398
399.. |AssociationRulesFilter_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRulesFilter.svg
400    :alt: AssociationRulesFilter
401    :width: 40
402    :height: 40
403
404.. |AssociationRulesExplorer_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/AssociationRulesExplorer.svg
405    :alt: Association Rules Explorer
406    :width: 40
407    :height: 40
408
409.. |ItemSets_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/Itemsets.svg
410    :alt: Item Sets
411    :width: 40
412    :height: 40
413
414.. |ItemSetsExplorer_icon| image:: ../../../Orange/OrangeWidgets/Associate/icons/ItemsetsExplorer.svg
415    :alt: Item Sets Explorer
416    :width: 40
417    :height: 40
418
419
420Unsupervised
421------------
422
423.. list-table::
424    :widths: 1 1 1
425    :class: widget-catalog-table widget-category-unsupervised
426   
427    * - |DistanceFile_icon| :ref:`Distance File`
428      - |SaveDistanceFile_icon| `Save Distance File`
429      - |MatrixTransformation_icon| `Matrix Transformation`
430    * - |DistanceMatrixFilter_icon| `Distance Matrix Filter`
431      - |DistanceMap_icon| :ref:`Distance Map`
432      - |ExampleDistance_icon| :ref:`Example Distance`
433    * - |AttributeDistance_icon| :ref:`Attribute Distance`
434      - |HierarchicalClustering_icon| :ref:`Hierarchical Clustering`
435      - |InteractionGraph_icon| :ref:`Interaction Graph`
436    * - |kMeansClustering_icon| :ref:`k-Means Clustering`
437      - |MDS_icon| :ref:`MDS`
438      - |PCA_icon| :ref:`PCA`
439    * - |SOM_icon| `SOM`
440      - |SOMVisualizer_icon| `SOM Visualizer`
441      -
442
443.. |DistanceFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/LoadDistances.svg
444    :alt: Distance File
445    :width: 40
446    :height: 40
447
448.. |SaveDistanceFile_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SaveDistances.svg
449    :alt: Save Distance File
450    :width: 40
451    :height: 40
452
453.. |MatrixTransformation_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/MatrixTransformation.svg
454    :alt: Matrix Transformation
455    :width: 40
456    :height: 40
457
458.. |DistanceMatrixFilter_icon| image:: ../../../Orange/OrangeWidgets/icons/DistanceFilter.png
459    :alt: Distance Matrix Filter
460    :width: 40
461    :height: 40
462
463.. |DistanceMap_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/DistanceMatrix.svg
464    :alt: Distance Map
465    :width: 40
466    :height: 40
467
468.. |ExampleDistance_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/Distance.svg
469    :alt: Example Distance
470    :width: 40
471    :height: 40
472
473.. |AttributeDistance_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/Distance.svg
474    :alt: Attribute Distance
475    :width: 40
476    :height: 40
477
478.. |HierarchicalClustering_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/HierarchicalClustering.svg
479    :alt: Hierarchical Clustering
480    :width: 40
481    :height: 40
482
483.. |InteractionGraph_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/InteractionGraph_40.png
484    :alt: Interaction Graph
485    :width: 40
486    :height: 40
487
488.. |kMeansClustering_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/kMeansClustering.svg
489    :alt: k-Means Clustering
490    :width: 40
491    :height: 40
492
493.. |MDS_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/MDS.svg
494    :alt: MDS
495    :width: 40
496    :height: 40
497
498.. |PCA_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/PCA.svg
499    :alt: PCA
500    :width: 40
501    :height: 40
502
503.. |SOM_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SOM.svg
504    :alt: SOM
505    :width: 40
506    :height: 40
507
508.. |SOMVisualizer_icon| image:: ../../../Orange/OrangeWidgets/Unsupervised/icons/SOMVisualizer.svg
509    :alt: SOM Visualizer
510    :width: 40
511    :height: 40
512
513
514Index:
515
516.. toctree::
517   :maxdepth: 1
518   
519   data/file.rst
520   data/datatable.rst
521   data/selectattributes.rst
522   data/rank.rst
523   data/purgedomain.rst
524   data/mergedata.rst
525   data/concatenate.rst
526   data/datasampler.rst
527   data/selectdata.rst
528   data/save.rst
529   data/discretize.rst
530   data/continuize.rst
531   data/impute.rst
532   data/outliers.rst
533   data/editdomain.rst
534   data/pythonscript.rst
535
536   visualize/distributions.rst
537   visualize/scatterplot.rst
538   visualize/attributestatistics.rst
539   visualize/linearprojection.rst
540   visualize/radviz.rst
541   visualize/polyviz.rst
542   visualize/parallelcoordinates.rst
543   visualize/surveyplot.rst
544   visualize/mosaicdisplay.rst
545   visualize/sievediagram.rst
546
547   classify/naivebayes.rst
548   classify/svm.rst
549   classify/logisticregression.rst
550   classify/majority.rst
551   classify/classificationtree.rst
552   classify/classificationtreegraph.rst
553   classify/classificationtreeviewer.rst
554   classify/cn2.rst
555   classify/cn2rulesviewer.rst
556   classify/knearestneighbours.rst
557   classify/nomogram.rst
558   classify/randomforest.rst
559   classify/c45.rst
560   classify/interactivetreebuilder.rst
561
562   regression/mean.rst
563   regression/linear.rst
564   regression/regressiontree.rst
565   regression/regressiontreegraph.rst
566   regression/pade.rst
567
568   evaluate/confusionmatrix.rst
569   evaluate/rocanalysis.rst
570   evaluate/liftcurve.rst
571   evaluate/calibrationplot.rst
572   evaluate/testlearners.rst
573   evaluate/predictions.rst
574
575   associate/associationrules.rst
576   associate/associationrulesfilter.rst
577   associate/associationrulesexplorer.rst
578
579   unsupervized/distancefile.rst
580   unsupervized/distancemap.rst
581   unsupervized/exampledistance.rst
582   unsupervized/attributedistance.rst
583   unsupervized/hierarchicalclustering.rst
584   unsupervized/interactiongraph.rst
585   unsupervized/kmeansclustering.rst
586   unsupervized/mds.rst
587   unsupervized/PCA.rst
588
589****************
590Index and search
591****************
592
593* :ref:`genindex`
594* :ref:`search`
Note: See TracBrowser for help on using the repository browser.