Documentation for Select by Data Index

Author: ajdapretnar

doc/visual-programming/source/index.rst

@@ -37,6 +37,7 @@ Data
    widgets/data/createclass
    widgets/data/randomize
    widgets/data/concatenate
+   widgets/data/select-by-data-index
    widgets/data/paintdata
    widgets/data/pythonscript
    widgets/data/featureconstructor

doc/visual-programming/source/widgets/data/icons/select-by-data-index.png

@@ -0,0 +1,35 @@
+Select by Data Index
+====================
+
+Match instances by index from data subset.
+
+Inputs
+    Data
+        reference data set
+    Data Subset
+        subset to match
+
+Outputs
+    Data
+        subset from reference data set that matches indices from subset data
+
+
+**Select by Data Index** enables matching the data by indices. Each row in a data set has an index and given a subset, this widget can match these indices to indices from the reference data. Most often it is used to retrieve the original data from the transformed data (say, from PCA space).
+
+.. figure:: images/Select-by-data-index-stamped.png
+   :scale: 50%
+
+1. Information on the reference data set. This data is used as index reference.
+2. Information on the data subset. The indices of this data set are used to find matching data in the reference data set. Matching data are on the output by default.
+
+Example
+-------
+
+A typical use of **Select by Data Index** is to retrieve the original data after a transformation. We will load *iris.tab* data in the **File** widget. Then we will transform this data with **PCA**. We can project the transformed data in a **Scatter Plot**, where we can only see PCA components and not the original features.
+
+Now we will select an interesting subset (we could also select the entire data set). If we observe it in a **Data Table**, we can see that the data is transformed. If we would like to see this data with the original features, we will have to retrieve them with **Select by Data Index**.
+
+Connect the original data and the subset from **Scatter Plot** to **Select by Data Index**. The widget will match the indices of the subset with the indices of the reference (original) data and output the matching reference data. A final inspection in another **Data Table** confirms the data on the output is from the original data space.
+
+.. figure:: images/Select-by-Data-Index-Example1.png
+