[R] First R Package --- Advice?
ivo.welch at anderson.ucla.edu
Wed Feb 6 16:41:19 CET 2013
a nice aspect about roxygen (and perl pod) is that it compiles into
the standard .Rd files. it's not a substitute, but a complement tool.
it may also make a good start for docs when one starts writing code,
and be eventually yanked out in favor of direct changes in the .Rd
files that it has created.
it may or may not be for code which is destined to become a real
package for third parties. for end users like me, it is about
documenting their own basic code to the point that they themselves
still understand it a year later. in a sense, roxygen comments (or
perl podl) are more lightweight than .Rd and more heavyweight than
just '#' comments.
Ivo Welch (ivo.welch at gmail.com)
More information about the R-help