make.packages.html           package:utils           R Documentation

_U_p_d_a_t_e _H_T_M_L _D_o_c_u_m_e_n_t_a_t_i_o_n _F_i_l_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Functions to link and (optionally) re-create the HTML
     documentation files to reflect all installed packages.

_U_s_a_g_e:

     make.packages.html(lib.loc = .libPaths(), packages = TRUE)

_A_r_g_u_m_e_n_t_s:

 lib.loc: character vector. List of libraries to be included.

packages: logical: should be package indices be create.

_D_e_t_a_i_l_s:

     This sets up the links from packages in libraries to the '.R'
     subdirectory of the per-session directory (see 'tempdir') and
     optionally creates the 'packages.html' and 'index.txt' files to
     point to those links.  The slow part is creating those files (as
     all the package 'DESCRIPTION' files are read).

     If a package is available in more than one library tree, all the
     copies are linked, after the first with suffix '.1' etc.

_V_a_l_u_e:

     Invisible logical, indicating if the files were created.

_S_e_e _A_l_s_o:

     'help.start'

_E_x_a_m_p_l_e_s:

     ## Not run: 
     # to prefer HTML help, put in your .Rprofile
     options(htmlhelp=TRUE)
     make.packages.html(packages=FALSE)
     # this can be slow for large numbers of installed packages.
     ## End(Not run)