getVignetteHeader           package:DynDoc           R Documentation

_A _f_u_n_c_t_i_o_n _t_o _r_e_a_d _v_i_g_n_e_t_t_e _h_e_a_d_e_r _i_n_f_o_r_m_a_t_i_o_n

_D_e_s_c_r_i_p_t_i_o_n:

     Given a vignette filename, will read in the vignette header
     metadata.

_U_s_a_g_e:

     getVignetteHeader(vig, field)
     hasVigHeaderField(vig, field="VignetteIndexEntry")

_A_r_g_u_m_e_n_t_s:

     vig: Vignette filename

   field: A specific field to extract

_D_e_t_a_i_l_s:

     The 'getVignetteHeader' function will extract the metadata from a
     vignette file and return it as a named list, where the names of
     the list elements correspond to the metadata fields, and the
     elements themselves the values.  If a specific field is desired,
     it can be specified with the 'field' argument.

     The 'hasVigHeaderField' function is a simple wrapper around
     'getVignetteHeader' and will most likely be removed in the very
     near future.  It just is a boolean to report if a given header
     field exists or not.

_A_u_t_h_o_r(_s):

     Jeff Gentry