Documentation is incomplete
Hi,
I am new to mapsf but not at all to R.
I face several issues using the documentation, which is a tad disappointing for such a good product and might hinder its adoption:
- both in the PDF documentation and in the Reference Manual, the links to the map type functions are broken, e.g, mf_choro -- as it seems, the map types functions are not referenced in the reference but are indeed in the R online help, when using VS Code
- The Martinique example in the main website could be more explanatory: one thinks, when reading "A more detailed example:" that the following is a brand new example when in fact it is the continuation of the previous example.
both in the PDF documentation and in the Reference Manual, the links to the map type functions are broken, e.g, mf_choro -- as it seems, the map types functions are not referenced in the reference but are indeed in the R online help, when using VS Code
Yes, indeed, that was (partly) done on purpose. I didn't want to overload the help page index accessible through R or IDE. So I try to hide these pages as much as possible and the result is not that good.
So, I've changed mf_map() help page and it makes these half-hidden help pages useless. You can install the new version and see the changes with:
remotes::install_github("riatelab/mapsf", ref = "doc_mf_map")
The Martinique example in the main website could be more explanatory: one thinks, when reading "A more detailed example:" that the following is a brand new example when in fact it is the continuation of the previous example.
Ok, PR welcome then :-)