#1: draft of documentation

README.md

@@ -3,6 +3,61 @@
 This is an early draft of [Orange3](http://orange.biolab.si) add-on with minimal
 awareness of data labeled with [HXL](https://hxlstandard.org/).
 
+## Features
+
+### Data Vault Conf
+[WORKING DRAFT] Configure active local data vault configurations. This allows overriding defaults.
+
+### Download Raw File
+
+Download remote resource into a local FileRAW
+
+### Unzip Raw File
+[WORKING DRAFT] Unzip (zip, gzip, bzip, ...) an FileRAW into an FileRAWCollection
+
+### Select Raw File
+[DRAFT] From a local FileRAWCollection, select an FileRAW
+
+### Load Raw File
+Convert a local FileRAW into Orange3 Data / DataFrame.
+Required to allow use with other widgets.
+
+Supported features (*):
+
+- `pandas.read_table`
+- `pandas.read_csv`
+- `pandas.read_excel`
+- `pandas.read_feather`
+- `pandas.read_fwf`
+- `pandas.read_html`
+- `pandas.read_json`
+- `pandas.json_normalize`
+- `pandas.read_orc`
+- `pandas.read_parquet`
+- `pandas.read_sas`
+- `pandas.read_spss`
+- `pandas.read_stata`
+- `pandas.read_xml`
+
+_(*) Some features will require additional python packages which are not installed by default with this add-on. The user will be warned about this._
+
+### Statistical Role
+
+Change statistical role (the "feature", "target", "meta", "ignore")
+using HXL patterns instead of stric exact names for the data variables.
+
+### Data Type
+
+[DRAFT] Change the computational data type (the "numeric", "categorical" "text", "datetime") using HXL patterns instead of stric exact names for the data variables.
+
+### HXL short names
+
+[EARLY DRAFT] Make HXLated input data with shorter variable names.
+
+### RAW Info
+[DRAFT] Inspect a FileRAW or FileRAWCollection
+
+
 <!--
 This is an example add-on for [Orange3](http://orange.biolab.si). Add-on can extend Orange either 
 in scripting or GUI part, or in both. We here focus on the GUI part and implement a simple (empty) widget,

README.pypi

@@ -1,11 +1,59 @@
-Orange3 Explain
+Orange3-HXLvisualETL
 ===============
 
-Short description for the PyPI.
-See [documentation](http://orange3-imageanalytics.readthedocs.org/).
+This is an early draft of [Orange3](http://orange.biolab.si) add-on with minimal
+awareness of data labeled with [HXL](https://hxlstandard.org/).
 
-Features
---------
-#### List of key features
-* Feature 1
-* Feature 2
+## Features
+
+### Data Vault Conf
+[WORKING DRAFT] Configure active local data vault configurations. This allows overriding defaults.
+
+### Download Raw File
+
+Download remote resource into a local FileRAW
+
+### Unzip Raw File
+[WORKING DRAFT] Unzip (zip, gzip, bzip, ...) an FileRAW into an FileRAWCollection
+
+### Select Raw File
+[DRAFT] From a local FileRAWCollection, select an FileRAW
+
+### Load Raw File
+Convert a local FileRAW into Orange3 Data / DataFrame.
+Required to allow use with other widgets.
+
+Supported features (*):
+
+- `pandas.read_table`
+- `pandas.read_csv`
+- `pandas.read_excel`
+- `pandas.read_feather`
+- `pandas.read_fwf`
+- `pandas.read_html`
+- `pandas.read_json`
+- `pandas.json_normalize`
+- `pandas.read_orc`
+- `pandas.read_parquet`
+- `pandas.read_sas`
+- `pandas.read_spss`
+- `pandas.read_stata`
+- `pandas.read_xml`
+
+_(*) Some features will require additional python packages which are not installed by default with this add-on. The user will be warned about this._
+
+### Statistical Role
+
+Change statistical role (the "feature", "target", "meta", "ignore")
+using HXL patterns instead of stric exact names for the data variables.
+
+### Data Type
+
+[DRAFT] Change the computational data type (the "numeric", "categorical" "text", "datetime") using HXL patterns instead of stric exact names for the data variables.
+
+### HXL short names
+
+[EARLY DRAFT] Make HXLated input data with shorter variable names.
+
+### RAW Info
+[DRAFT] Inspect a FileRAW or FileRAWCollection

orangecontrib/hxl/widgets/downloadfile.py

@@ -19,7 +19,7 @@ class HXLDownloadFile(OWWidget):
     name = "Download Raw File"
     id = "orangecontrib.hxl.widgets.downloadfile"
     description = """
-    [DRAFT] Download remote resource into a local FileRAW
+    Download remote resource into a local FileRAW
     """
     icon = "icons/mywidget.svg"
     priority = 50  # where in the widget order it will appear

orangecontrib/hxl/widgets/hxlauto.py

@@ -26,7 +26,7 @@ class HXLAuto(OWWidget):
     # id = "orange.widgets.data.info"
     description = """
     Change statistical role (the "feature", "target", "meta", "ignore")
-    using HXL
+    using HXL patterns instead of stric exact names for the data variables.
     """
     icon = "icons/mywidget.svg"
     priority = 130  # where in the widget order it will appear

orangecontrib/hxl/widgets/shortnames.py

@@ -22,7 +22,7 @@ class HXLShortNames(OWWidget):
     # and not shown in the menu.
     name = "HXL short names"
     description = """
-    Make HXLated input data with shorter variable names.
+    [EARLY DRAFT] Make HXLated input data with shorter variable names.
     """
     icon = "icons/mywidget.svg"
     priority = 9995  # where in the widget order it will appear

orangecontrib/hxl/widgets/vaultconf.py

@@ -17,7 +17,7 @@ class HXLDataVaultConf(OWWidget):
     id = "orangecontrib.hxl.widgets.vaultconf"
     description = """
     [DRAFT] Configure active local data vault configurations.
-    This allow override defaults.
+    This allows overriding defaults.
     """
     icon = "icons/mywidget.svg"
     priority = 10  # where in the widget order it will appear

setup.py

@@ -7,7 +7,7 @@
 
 NAME = "Orange3-HXLvisualETL"
 
-VERSION = "0.1.6"
+VERSION = "0.2.0"
 
 AUTHOR = 'EticaAI'
 AUTHOR_EMAIL = '[email protected]'