getPkgVigList             package:DynDoc             R Documentation

_A _f_u_n_c_t_i_o_n _t_o _r_e_t_r_i_e_v_e _a _l_i_s_t_i_n_g _o_f _p_a_c_k_a_g_e _v_i_g_n_e_t_t_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     Functionality to retrive vignette metadata, on a per-vignette or a
     per-package level.

_U_s_a_g_e:

     getPkgVigList(pkg, vigDescFun=baseVigDesc, vigPath = "/doc/", 
     vigExt="\.(Rnw|Snw|rnw|snw|Rtex)$", pkgVers = TRUE)

     getVigInfo(vig,pkg=NULL, vigDescFun=baseVigDesc, pkgVers=TRUE)

_A_r_g_u_m_e_n_t_s:

     pkg: Path to a package directory

     vig: Filename of a vignette

vigDescFun: Function to provide output string for display

 vigPath: Path to directory that contains vignettes in the package

  vigExt: Regular expression pattern to match vignette file extensions

 pkgVers: Record the package version with the other vignette metadata

_D_e_t_a_i_l_s:

     getPkgVigList: This function will look at all vignette files in
     the directory '<pkg>/<vigPath>'.  It will then extract any header
     information (using 'getVigInfo'), and return a list of this
     information.

     getVigInfo:  This function will retrieve the metadata from a
     particular vignette file.  Any line starting with '%\Vignette' is
     taken to be metadata.  Common values include VignetteIndexEntry
     (required), VignetteKeywords, VignetteDepends, etc.  A named list
     of lists is returned to the user, where the names correspond to
     the particular metadata variable.

     Both functions take a parameter 'baseVigDesc', which is a function
     to provide the output string to correspond with a vignette
     summary.  This function is directly called by 'getVigInfo'.  It
     takes one parameter, which is a vigInfo list from 'getVigInfo'.

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'vignette'

_E_x_a_m_p_l_e_s:

     ## Not run: 
        ## We need a vignette for this to work
        dynPath <- .path.package("DynDoc")
        vigList <- getPkgVigList(dynPath)
        vigList
     ## End(Not run)