Displaying 1 result from an estimated 1 matches for "myneatfunction".
2009 Oct 01
1
Looking for a better way to document my packages
...e thing is, from years of programming other
languages prior to landing in the R pond, I've grown accustomed to
documenting my functions inline. I'm not just used to it, but I like
it more than having function documentation completely removed from my
function, code.
So, for example
myNeatFunction <- function(arg1, arg2, arg3=NULL, ...) {
# One liner describing the neat thing this function does.
#
# More comments, probably very much what would be in the
# \description section of the *Rd
#
# Parameters
# ----------
# arg1 : <some comments>
# arg2 : <some...