vignette               package:DynDoc               R Documentation

_V_i_g_n_e_t_t_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Retrieves information about the vignettes from either all packages
     or a set of specific packages.

_U_s_a_g_e:

     vignette(package=.packages(all.available=TRUE), libs, filter,
              vigDescFun=baseVigDesc, vigPath="/doc")

_A_r_g_u_m_e_n_t_s:

 package: A name or character vector giving the packages to look into
          for vignettes.  By default, all packages in the search path
          are used.

    libs: A character vector of directory names representing R
          libraries.  If provided these directories will be where the
          system searches for packages, otherwise .libPaths() is used.

  filter: Allows for filtering of vignettes from display

vigDescFun: Function to provide output string for display

 vigPath: Directory path in a package directory for vignettes

_D_e_t_a_i_l_s:

     This function will look at a set of packages and extract
     information from any vignettes that are available.  It will then
     return a 'pkgFileList' object describing these vignettes.

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'openVignette', 'vExplorer'

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

        vignette()

