find.documented {mvbutils} | R Documentation |
Support for flat-format documentation
Description
find.documented
locates functions that have flat-format documentation; the functions and their documentation can be separate, and are looked for in all the environments in pos
, so that functions documented in one environment but existing in another will be found. find.docholder
says where the documentation for one or more functions is actually stored. Both find.documented
and find.docholder
check two types of object for documentation: (i) functions with "doc" attributes, and (ii) character-mode objects whose name ends in ".doc"
Usage
find.documented( pos=1, doctype=c( "Rd", "casual", "own", "any"),
only.real.objects=TRUE)
find.docholder( what, pos=find( what[1]))
Arguments
pos |
search path position(s), numeric or character. In |
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 (i) any |
only.real.objects |
If TRUE, only return names of things that exist somewhere in the |
what |
names of objects whose documentation you're trying to find. |
Value
find.documented |
Character vector of function names. |
find.docholder |
list whose names are |
Note
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, but these are checked for and removed.
Start informal documentation (i.e. not intended for doc2Rd
) with a blank line to avoid confusion.
Author(s)
Mark Bravington