

   undoc {base}                                 R Documentation

   FFiinndd UUnnddooccuummeenntteedd OObbjjeeccttss

   DDeessccrriippttiioonn::

        Finds the objects in a package which are undocumented,
        in the sense that they are visible to the user but no
        documentation entry exists.

   UUssaaggee::

        undoc(pkg, dir, code.dir, docs.dir)

   AArrgguummeennttss::

        pkg: a character string naming an installed package

        dir: a character string specifying the path to a pack-
             age's root source directory (containing the subdi-
             rectories `R' with R code and `man' with Rd docu-
             mentation sources, respectively.

   code.dir: a character string specifying the path to a pack-
             age's R code source (`R') directory.

   docs.dir: a character string specifying the path to a pack-
             age's Rd documentation source (`man') directory.

   DDeettaaiillss::

        This function is useful for package maintainers mostly.
        In principle, all user level R objects should be docu-
        mented; note however that the precise rules for docu-
        menting methods of generic functions are still under
        discussion.

        Currently, it is not checked whether documentation
        exists for all data objects the package provides.

   VVaalluuee::

        A character vector containing the names of the undocu-
        mented objects.

   EExxaammpplleess::

        undoc("eda")                   # Undocumented objects in `eda'

