[idea] Make vignettes from tests

[lrnv]

It looks like your test suite is well build, congratulation. However as I already noted your documentation is lacking.

One good idea would be to transform each of the test files into its own vignette, to give your users a few examples on how things should be done / can be done using your package.

You have 4 test files, each describing and testing a particular functionality of the package. Leverage them to write vignettes, which would include on top of the code runnig the test exemples a few paragraphs each of descriptions of what it does, what it is, where are the relevant references, etc...

[ahudde]

Dear @lrnv,
Thank you very much for this idea! Thanks to your help in other issues, the documentation has already improved a lot. Does this suffices in your eyes?

[lrnv]

On the documentation part, yes it is very good. But on R packages, people like to have vignettes: the CRAn references them, and people usually read them more than the docs themselves.

I do not want to consider this a blocker for the package acceptation at JOSS, but I'd rather see this as an opportunity for you to get more attraction. Moreover, this is not a huge work:

• Take the examples that are already in your documentations
• Write a bit of context on why and how they work, leveraging, again, your documentation and your own knowledge of your own code.

If you want to postponne, I'd totally understand.

[ahudde]

Dear @lrnv , thank you very much for the advice, and also for your understanding! I will work on it, but I everything goes, potentially after the acceptation.

[lrnv]

Fair enough !