document each function following roxygen rules

[timflutre]

Documenting functions should be compulsory, and the best place to do it is right above the function itself. This can be quickly and easily done with the roxygen2 syntax, as explained here by H. Wickham.

In RStudio, put the cursor at the beginning of the function, then click on Code, then Insert Roxygen Skeleton. Here is a screenshot.