matildabrown / rWCVP

Generating Summaries, Reports and Plots from the World Checklist of Vascular Plants
https://matildabrown.github.io/rWCVP/
GNU General Public License v3.0
19 stars 0 forks source link

Documentation doesn't explain what different outputs are #22

Open barnabywalker opened 2 years ago

barnabywalker commented 2 years ago

Diving back into this, I didn't really get the difference between a summary table, a checklist, and an occurrence matrix.

We should add an explanation of what these are, their differences, and their uses in the description field of the function documentation.

matildabrown commented 2 years ago

There's a markdown file that goes through this and showcases each one, I think - would that be helpful just to link to?

barnabywalker commented 2 years ago

I think a brief explanation of e.g. what a checklist is in the function docs would be really useful. If someone's quickly checking they're using the right function, they might not want to go through an article to find out. But also, including some sort of link to the articles would be good.