Vignette-class            package:DynDoc            R Documentation

_A _C_l_a_s_s _T_o _R_e_p_r_e_s_e_n_t _V_i_g_n_e_t_t_e_s

_D_e_s_c_r_i_p_t_i_o_n:

     This is a class that will represent a vignette file in R, it
     extends the DynDoc class

_S_l_o_t_s:

     '_p_a_c_k_a_g_e': Object of class '"character"' The package that this
          vignette is associated with

     '_v_i_g_P_k_g_V_e_r_s_i_o_n': Object of class '"VersionNumber"' The version
          number for this vignette's package

     '_i_n_d_e_x_E_n_t_r_y': Object of class '"character", from class "DynDoc"'
          The VignetteIndexEntry field from the document file

     '_t_i_t_l_e': Object of class '"character", from class "DynDoc"' The
          title of the vignette

     '_p_a_t_h': Object of class '"character", from class "DynDoc"' The
          path to the vignette file stored locally

     '_p_d_f_P_a_t_h': Object of class '"character", from class "DynDoc"' The
          path to a PDF representation of the vignette

     '_d_e_p_e_n_d_s': Object of class '"character", from class "DynDoc"' Any
          package dependencies for this vignette

     '_r_e_q_u_i_r_e_s': Object of class '"character", from class "DynDoc"' Any
          requires level dependencies for this vignette

     '_s_u_g_g_e_s_t_s': Object of class '"character", from class "DynDoc"' Any
          suggests level dependencies for this vignette

     '_k_e_y_w_o_r_d_s': Object of class '"character", from class "DynDoc"' Any
          keywords for this vignette

     '_c_o_d_e_C_h_u_n_k_s': Object of class '"chunkList", from class "DynDoc"' A
          list of code chunks from this vignette

_E_x_t_e_n_d_s:

     Class '"DynDoc"', directly.

_M_e_t_h_o_d_s:

     _p_a_c_k_a_g_e 'signature(object = "Vignette")': Retrieves the package
          name that this vignette is associated with

     _v_i_g_P_k_g_V_e_r_s_i_o_n 'signature(object = "Vignette")': Retrieves the
          version of the package that this vignette is associated with

_N_o_t_e:

     The 'Vignette' class is extending the 'DynDoc' class by further
     associating the 'DynDoc' concepts with a specific R package.

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'DynDoc-class', 'Sweave'