undoc                  package: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 (or data objects provided
     by the package), but no documentation entry exists.

_U_s_a_g_e:

     undoc(pkg, 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 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.

_D_e_t_a_i_l_s:

     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.

_V_a_l_u_e:

     A character vector containing the names of the undocumented
     objects.

_E_x_a_m_p_l_e_s:

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

