index.search              package:utils              R Documentation

_S_e_a_r_c_h _I_n_d_i_c_e_s _f_o_r _H_e_l_p _F_i_l_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Used to search the indices for help files, possibly under aliases.

_U_s_a_g_e:

     index.search(topic, path, file="AnIndex", type = "help")

_A_r_g_u_m_e_n_t_s:

   topic: The keyword to be searched for in the indices.

    path: The path(s) to the packages to be searched.

    file: The index file to be searched.  Normally '"AnIndex"'.

    type: The type of file required.

_D_e_t_a_i_l_s:

     For each package in 'path', examine the file 'file' in directory
     'type', and look up the matching file stem for topic 'topic', if
     any.

_V_a_l_u_e:

     A character vector of matching files, as if they are in directory
     'type' of the corresponding package. In the special cases of 'type
     = "html"', '"R-ex"' and '"latex"' the file extensions '".html"',
     '".R"' and '".tex"' are added.

_S_e_e _A_l_s_o:

     'help', 'example'

