

undoc {base}                                 R Documentation

_F_i_n_d _U_n_d_o_c_u_m_e_n_t_e_d _O_b_j_e_c_t_s

_D_e_s_c_r_i_p_t_i_o_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_s_a_g_e_:

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

_A_r_g_u_m_e_n_t_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_e_t_a_i_l_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_a_l_u_e_:

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

_E_x_a_m_p_l_e_s_:

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

