Aggregate Columns: Documentation

Author: ajdapretnar

doc/visual-programming/source/index.rst

@@ -31,6 +31,7 @@ Data
    widgets/data/sqltable
    widgets/data/save
    widgets/data/datainfo
+   widegts/data/aggregatecolumns
    widgets/data/datatable
    widgets/data/selectcolumns
    widgets/data/selectrows

doc/visual-programming/source/widgets/data/aggregatecolumns.md

@@ -0,0 +1,37 @@
+Aggregate Columns
+=================
+
+Compute a sum, max, min ... of selected columns.
+
+**Inputs**
+
+- Data: input dataset
+
+**Outputs**
+
+- Data: extended dataset
+
+**Aggregate Columns** outputs an aggregation of selected columns, for example a sum, min, max, etc.
+
+![](images/AggregateColumns.png)
+
+1. Selected attributes.
+2. Operator for aggregation:
+   - sum
+   - product
+   - min
+   - max
+   - mean
+   - variance
+   - median
+3. Set the name of the computed attribute.
+4. If *Apply automatically* is ticked, changes will be communicated automatically. Alternatively, click *Apply*.
+
+Example
+-------
+
+We will use iris data from the [File](../data/file.md) widget for this example and connect it to **Aggregate Columns**.
+
+Say we wish to compute a sum of *sepal_length* and *sepal_width* attributes. We select the two attributes from the list.
+
+![](images/AggregateColumns-Example.png)

doc/visual-programming/source/widgets/data/images/AggregateColumns-Example.png

@@ -73,6 +73,22 @@
      "inspect"
     ]
    },
+   {
+    "text": "Aggregate Columns",
+    "doc": "visual-programming/source/widgets/data/aggregatecolumns.md",
+    "icon": "../Orange/widgets/data/icons/AggregateColumns.svg",
+    "background": "#FFD39F",
+    "keywords": [
+     "aggregate",
+     "sum",
+     "product",
+     "max",
+     "min",
+     "mean",
+     "median",
+     "variance"
+    ]
+   },
    {
     "text": "Data Sampler",
     "doc": "visual-programming/source/widgets/data/datasampler.md",