LebeerLab / tidytacos

Functions to manipulate and visualize microbial community data
https://lebeerlab.github.io/tidytacos/
GNU General Public License v3.0
9 stars 1 forks source link

No examples for the filter/mutate/select functions #32

Closed david-barnett closed 3 months ago

david-barnett commented 4 months ago

None of the functions in handlers.R have examples on their help pages.

https://github.com/LebeerLab/tidytacos/blob/master/R/handlers.R

You might like to combine a few of the related help pages together, e.g. all the filtering functions,

But I definitely think you need to give at least one working example for each function, or otherwise direct users who look in the help where to find examples elsewhere.

david-barnett commented 4 months ago

This is actually a more general problem. Most (?) functions don't have examples on their help pages.

I feel you need to add examples on help pages, or direct to specific places in online documentation