Pimp the documentation

[ColinFay]

It's currently hard to navigate through the various dataset:

• Help pages are not informative: column with types doesn't help understanding what they mean, and description + usage doesn't inform about the content of the dataset

• Home page just displays the name of the dataset

Given that a lot of these are described in the Vignette, I suggest we reuse these information inside the dataset documentation?

[KittJonathan]

Still need help on that issue ?

[statnmap]

Your help would be very welcome.
However, I need to warn you that this issue may be painful...
We created the datasets documentation programmatically using checkhelper::use_data_doc(): https://github.com/ThinkR-open/checkhelper
This allows to extract column names and gives the type.

The present issue asks to add the full description of columns. You could probably imagine something programmatically, using description_indiv table for instance, but I think that programming this may be a little longer than writing it manually.

There are two propositions:

• You can decide to pimp the use_data_doc() function, so that it allows a table of correspondence in which looking for descriptions. Then use it over the entire set of data. You may have to clean the R/ directory first.
• You can manually get the information from the vignette and paste it in the correct place for all tables: https://thinkr-open.github.io/inca3/articles/aa-presentation-tables.html

[KittJonathan]

Okay, I'll get the information from the vignette you linked and paste it. I've done it for the "occasions" table as a test.