add.flatdoc.to {mvbutils} | R Documentation |
Adds skeleton flat-format documentation to a function, suitable for conversion to Rd-format using doc2Rd
. The result should pass RCMD CHECK (but won't be much use until you actually edit the documentation).
# See *Examples* for practical usage add.flatdoc.to(x, char.x = NULL, pkg=NULL)
x |
unquoted function name, sought in parent.frame() unless pkg is set |
char.x |
[string] function name |
pkg |
[string] name of maintained package where x lives (optional) |
You don't have to write Rd-compatible documentation from the outset. You can write documentation that's as free-form as you wish, and there's no need to use add.flatdoc.to
to do it– you can write the doco directly in your text editor provided that you can source
the resultant melange OK (see fixr
). I find add.flatdoc.to
useful, though, because I can never remember the headings or mild layout conventions of doc2Rd
and Rd-format itself.
A function with attribute docattr
containing the flat-format documentation.
myfun <- function( ...) ... myfun <- add.flatdoc.to( myfun) # 'fixr( myfun)' will now allow editing of code & doco together # Or, in a maintained package: # ..mypack$myfun <<- add.flatdoc.to( myfun, pkg='mypack')