DynDoc-class             package:DynDoc             R Documentation

_A _C_l_a_s_s _F_o_r _D_y_n_a_m_i_c _D_o_c_u_m_e_n_t_s

_D_e_s_c_r_i_p_t_i_o_n:

     The DynDoc class is used to represent dynamic documents and
     vignettes in R.

_S_l_o_t_s:

     '_i_n_d_e_x_E_n_t_r_y': Object of class '"character"' The IndexEntry value
          from the document file

     '_t_i_t_l_e': Object of class '"character"' The name of the document

     '_p_a_t_h': Object of class '"character"' The path to the locally
          stored file

     '_p_d_f_P_a_t_h': Object of class '"character"' The path to a PDF
          rendition of the document

     '_d_e_p_e_n_d_s': Object of class '"character"' Any package dependencies
          for the document

     '_r_e_q_u_i_r_e_s': Object of class '"character"' Any requires level
          dependencies for the document

     '_s_u_g_g_e_s_t_s': Object of class '"character"' Any suggests level
          dependencies for the document

     '_k_e_y_w_o_r_d_s': Object of class '"character"' Any keywords for the
          document

     '_c_o_d_e_C_h_u_n_k_s': Object of class '"chunkList"' The code chunks
          contained in this document

_M_e_t_h_o_d_s:

     _s_h_o_w 'signature(object = "DynDoc")': Display information about the
          dynamic document

     _s_u_m_m_a_r_y 'signature(object = "DynDoc")': A more succinct
          informational display

     _c_h_u_n_k_s 'signature(object = "DynDoc")': Returns the code chunks -
          currently in only for historical compatability with old code

     _c_o_d_e_C_h_u_n_k_s 'signature(object = "DynDoc")': Returns the code chunks

     _e_v_a_l_C_h_u_n_k 'signature(object = "DynDoc")': Will evaluate the R code
          contained in a chunk

     _g_e_t_C_h_u_n_k 'signature(object = "DynDoc")': Retrieves a specific code
          chunk

     _g_e_t_D_e_p_e_n_d_s 'signature(object = "DynDoc")': Obtain the Depends slot
          of the object

     _g_e_t_K_e_y_w_o_r_d_s 'signature(object = "DynDoc")': Obtain the keywords
          slot of the object

     _g_e_t_R_e_q_u_i_r_e_s 'signature(object = "DynDoc")': A get method for the
          requires slot of this object

     _g_e_t_S_u_g_g_e_s_t_s 'signature(object = "DynDoc")': Obtain the suggests
          slot of this object

     _i_n_d_e_x_E_n_t_r_y 'signature(object = "DynDoc")': Obtain the indexEntry
          slot of this object

     _n_u_m_C_h_u_n_k_s 'signature(object = "DynDoc")': Returns the number of
          code chunks for this document 

     _p_a_t_h 'signature(object = "DynDoc")': Obtain the path slot of this
          object

     _p_d_f_P_a_t_h 'signature(object = "DynDoc")': Obtain the pdfPath slot of
          this object

     _s_e_t_C_h_u_n_k<- 'signature(object = "DynDoc")': Change the code for one
          of the code chunks.

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'Sweave'