vignetteDepends            package:tools            R Documentation

_A _f_u_n_c_t_i_o_n _t_o _r_e_t_r_i_e_v_e _d_e_p_e_n_d_e_n_c_y _i_n_f_o_r_m_a_t_i_o_n _f_o_r _a _v_i_g_n_e_t_t_e

_D_e_s_c_r_i_p_t_i_o_n:

     Given a vignette name, will create a DependsList object that
     reports information about the packages the vignette depends on.

_U_s_a_g_e:

     vignetteDepends(vignette, recursive = TRUE, reduce = TRUE, local=TRUE, lib.loc=NULL)

_A_r_g_u_m_e_n_t_s:

vignette: The name of the vignette

recursive: Whether or not to include indirect dependencies

  reduce: Whether or not to collapse all sets of dependencies to a
          minimal value

   local: Whether or not to search only locally

 lib.loc: What libraries to search in locally

_D_e_t_a_i_l_s:

     If 'recursive' is 'TRUE', any package that is specified as a
     dependency will in turn have its dependencies included (and so
     on), these are known as indirect dependencies.  If recursive is
     'FALSE', only the dependencies directly named by the vignette will
     be used.

     If 'local' is 'TRUE', the system will only look at the user's
     local machine and not online to find dependencies.

     If 'reduce' is 'TRUE', the system will collapse the fields in the
     'DependsList' to the minimal set of dependencies (for instance if
     the dependencies were ('foo', 'foo (>= 1.0.0)',  'foo (>=
     1.3.0)'), the return value would be 'foo (>= 1.3.0)').

_V_a_l_u_e:

     An object of class 'DependsList'

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'pkgDepends'

_E_x_a_m_p_l_e_s:

        ## We aren't guaranteed any vignettes in the base set of
        ## packages (yet) that I know of.

