mvbutils (version 1.1.0)

find.documented: Support for flat-format documentation

Description

Finds functions with flat-format documentation.

Usage

find.documented( pos=1, doctype=c( "Rd", "casual", "own", "any"))
find.docholder( funs, pos=<>)

Arguments

pos

search path position(s), numeric or character. In find.documented, any length; in find.docholder, only pos[1] will be used.

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 doc2

funs

names of objects whose documentation you're trying to find.

Value

• 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.

See Also

doc2Rd, dochelp