Minimal Viable Product of documentation of orange3-hxl

[fititnt]

• Initial discussion:
  • HXL (The Humanitarian Exchange Language) aware addon for Orange3 biolab/orange3#6092
• Based on template:
  • https://github.com/biolab/orange3-example-addon
• Cited Orange extensions:
  • Geo
    • https://github.com/biolab/orange3-geo
      • Example: https://orangedatamining.com/widget-catalog/geo/choroplethmap/

---

Okay. I think I got the quick general idea of how to create Orange3 add-on. But still need to know more about how to use the interface itself, because some features at first would seem necessary, already are implemented on other extensions.

While the minimal viable product of an extension still need some time (again, more because need to understand features, think like user) this very first issue already is about document the orange3-hxl.

Anyway, to avoid create a lot of other issues, maybe will do it in other repositories from @EticaAI / @HXL-CPLP and leave here mostly for the extension itself.

Things that other Orange3 extensions likely would not have

For sake of MVP, this issue likely will not implement all these features.

Converters for HXL / HXLM / HXL+RDF with BCP47 syntax

On this point, could make sense simply also port the python funcitonality we have on https://github.com/EticaAI/hxltm and https://github.com/EticaAI/lexicographi-sine-finibus

Reference tables for vocabularies (internal use)

For sake of simplify conversors, I think migth be relevant start to break some conversors not already purely with simpler rules to machine-parseable data files.

However, this also would need changes on the upstream

Pre-build reference tables related to places (e.g. COD-ABs, P-Codes)

geometries

Orange3 already have https://github.com/biolab/orange3-geo, which for example allows data visualization with maps. Likely there's other features, but this extension is quite relevant here.

However, at later point we migth need to pre-compile and share online geojsons, like these ones https://github.com/biolab/orange3-geo/tree/master/orangecontrib/geo/geojson. Maybe also allow user change the data provider.

But in any case, trying to store all the geojsons with single python package would likely to take too much space. So, while I did not checked if orange3-geo allows changes the geometries, anything additional would need to consider how to package the files.

P-Codes to Latitude/Longitude

Somewhat related: EticaAI/lexicographi-sine-finibus#45

To use orange3-geo as output, since it uses latitude/longitude pair, means most datasets would need to have this pre-compiled. This would really require fetch all geometries from ~150 of COD-ABs and create this.

However, as somewhat expected, the https://github.com/biolab/orange3-geo/tree/master/orangecontrib/geo/geojson have only world and level 1, so it would not be possible to map lower levels without also care of distributing the geometries. Another issue is that already at admin1, I think that some latitude/longitude might already be outside of the ones on orange3-geo, but this is something to test later.

[fititnt]

Okay. We will need to break this package in at least two as option for Orange3 add on.

Under this new approach, current package would be something such as "HXL visual ETL" and a new one would be dedicated into have widgets to provide source for referential data very specialized.

The reason for another specialized package focused in having widget very specialized is because it would be easier to make something this way to "populate" additional fields based on key data of the user really want. There's more than one way (including the user making complex steps with this tool, but the documentation could become complex. Also, the types of referential data would be very specialized (worst case: have more than one provider, but the schemas would still be reusable)