Review and update function documentation - Githubissues

adokter / bioRad

R package for analysis and visualisation of biological signals in weather radar data

http://adokter.github.io/bioRad

Other

29 stars 16 forks source link

Review and update function documentation #94

Open peterdesmet opened 6 years ago

peterdesmet commented 6 years ago

Review for each function:

Styleguide: Follows http://style.tidyverse.org/ styleguide. Test with styler::style_pkg(filetype = c("R", "Rmd")) and optionally lintr::lint_package()
Language: Is the text clear and succinct? Don't use word object for each object
Example: Good, clear example?

See also https://docs.google.com/spreadsheets/d/1EhdHaHTF3paiU3PlNUkxPhUz_DgwVXdW8fcDaZn7XyM/edit

peterdesmet commented 5 years ago

Styling is now done with styler package on all R files: f55b4e6

peterdesmet commented 5 years ago

I would argue that function documentation is sufficient for now. Could be picked up again for rOpenSci onboarding. I'll move this to later milestone.