Create documentation exporter

[blootsvoets]

Question: how to make data schemas and documentation more accessible for researchers and analysts?

Ideally, the tools will have an exporter that creates a browsable archive of the specifications and schemas used. This way, analysts can navigate the documentation of the schemas instead of relying only on a JSON file in the output directory. Specifications can be used to give more comprehensive documentation about the real-time behaviour of a stream, for example:

• caveats about collection rates, accuracy, Android/phone version dependencies
• pseudonymization methods
• causes for missing data
  This archive should also be hosted by the radar-base platform (e.g. in RADAR-Docker).

The alternative would be an interactive frontend, however, that would mean that analysts need to keep the RADAR-base instance running even after data collection has finished.

We could use a templating engine like mustache with a Java generator, or fully delegate the site creation to something like Jekyll

[afolarin]

Great idea!
Are you thinking about something like this https://www.openmhealth.org/documentation/#/schema-docs/schema-library but per source rather than data type?

Might be interesting to also provide some basic design checking also on new schema proposals? Perhaps extending the work in radar-schemas-tools?

[blootsvoets]

Yes, something like that indeed, by extending radar-schemas-tools. Possibly a bit less ambitious than that portal though... We can at least make more accessible the documentation we already have though.