find.documented {mvbutils} | R Documentation |
Finds functions with flat-format documentation.
find.documented( pos=1, doctype=c( "Rd", "casual", "own", "any")) find.docholder( funs, pos=)
pos |
search path position(s), numeric or character. In find.documented , any length. In find.docholder , only pos[1] will be used, and pos defaults to where funs are found. |
doctype |
Defaults to "Rd". If supplied, it is partially matched against the choices in USAGE. "Rd" functions are named in the alias list at the start of any doc attribute of a function in pos (see doc2Rd ); "casual" functions have their own doc attribute, and will be found by the replacement of help ; "own" functions (a subset of "casual") have their own character-mode doc attribute, and are suitable for doc2Rd ; "any" combines casual and Rd . |
funs |
names of objects whose documentation you're trying to find. |
find.documented |
Character vector of function names. |
find.docholder |
list whose names are funs ; each element is a character vector showing which objects have documentation for the named object. Normally you'd expect either 0 or 1 entries in the character vector; more than 1 would imply duplication. |
doctype="Rd"
looks for the alias names, i.e. the first word of all lines occurring before the first blank line. This may include non-existent objects.
Start informal documentation (i.e. not intended for doc2Rd
) with a blank line to avoid confusion.
Mark Bravington