| undoc {base} | R Documentation |
Find Undocumented Objects
Description
Finds the objects in a package which are undocumented, in the sense that they are visible to the user but no documentation entry exists.
Usage
undoc(pkg, dir, code.dir, docs.dir)
Arguments
pkg |
a character string naming an installed package |
dir |
a character string specifying the path to a package's root source directory (containing the subdirectories ‘R’ with R code and ‘man’ with Rd documentation sources, respectively. |
code.dir |
a character string specifying the path to a package's
R code source ( |
docs.dir |
a character string specifying the path to a package's
Rd documentation source ( |
Details
This function is useful for package maintainers mostly. In principle, all user level R objects should be documented; note however that the precise rules for documenting methods of generic functions are still under discussion.
Currently, it is not checked whether documentation exists for all data objects the package provides.
Value
A character vector containing the names of the undocumented objects.
Examples
undoc("eda") # Undocumented objects in `eda'