Roxygen documentation
Document the functions with Roxygen2.
Roxygen is very advisable because, apart from documenting the code, it provides some automatic hooks for correct package building. For example, instead of library()
calls (which are not allowed in the R files included in the package), libraries need to be included in the DESCRIPTION
file. Roxygen parses the header of the function looking for @import
and @importFrom
statements and includes the dependencies in DESCRIPTION
for us.
Very simple documentation with the Title + Description + Parameters + Result + Details + Imports/Exports. Example here.
At this point, I wouldn't waste time preparing examples.
Edited by Sayols Puig, Sergi