Find Undocumented Objects
Finds the objects in a package which are undocumented, in the sense that they are visible to the user (or data objects or S4 classes provided by the package), but no documentation entry exists.
undoc(package, dir, lib.loc = NULL)
- a character string naming an installed package.
- a character string specifying the path to a package's root source directory. This must contain the subdirectory man with R documentation sources (in Rd format), and at least one of the R or data subdirectories with R code or data objects, respectively.
- a character vector of directory names of R libraries,
NULL. The default value of
NULLcorresponds to all libraries currently known. The specified library trees are used to search for
This function is useful for package maintainers mostly. In principle, all user-level R objects should be documented.
The base package is special as it contains the primitives and
these do not have definitions available at code level. We provide
equivalent closures in environments
.GenericArgsEnv in the base package that are used
for various purposes:
undoc("base") checks that all the
primitives that are not language constructs are prototyped in those
environments and no others are.
An object of class
"undoc"which is a list of character vectors containing the names of the undocumented objects split according to documentation type.There is a
undoc("tools") # Undocumented objects in 'tools'