vignetteCode-class          package:DynDoc          R Documentation

_C_l_a_s_s "_v_i_g_n_e_t_t_e_C_o_d_e"

_D_e_s_c_r_i_p_t_i_o_n:

     This class represents the code chunks and other related
     information from a vignette file.  It also provides for the
     ability to evaulate the code chunks in a separate environment.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

     Objects can be created by calls of the form 'new("vignetteCode",
     ...)' Also, a helper function 'getVignetteCode' is provided that
     will do all of the dirty work required to retrieve a
     'vignetteCode' object from a vignette file.

_S_l_o_t_s:

     '_c_h_u_n_k_L_i_s_t': Object of class '"chunkList"' Holds the code chunks
          from the vignette file

     '_p_a_t_h': Object of class '"character"' The path of the vignette
          file 

     '_p_a_c_k_a_g_e': Object of class '"character"' The package (if
          appropriate) that the vignette came from 

     '_g_e_t_D_e_p_e_n_d_s': Object of class '"character"' Any package
          dependencies for the vignette 

     '_e_v_a_l_E_n_v': Object of class '"environment"' An environment used for
          evaulation of the code chunks.

_M_e_t_h_o_d_s:

     _s_h_o_w 'signature(object = "vignetteCode")': Displays information
          about the code contained in the object

     _c_h_u_n_k_L_i_s_t 'signature(object = "vignetteCode")': Retrieves the
          'chunkList' object.

     _c_h_u_n_k_s 'signature(object = "vignetteCode")': Retrieves the actual
          code chunks (not wrapped by the 'chunkList' class) 

     _g_e_t_D_e_p_e_n_d_s 'signature(object = "vignetteCode")': Returns the list
          of package dependencies for this vignette

     _e_v_a_l_C_h_u_n_k 'signature(object = "vignetteCode",pos="numeric")': Will
          evaulate the specified code chunk in the 'evalEnv'
          environment

     _e_v_a_l_E_n_v 'signature(object = "vignetteCode")': Returns the
          evaluation environment

     _g_e_t_C_h_u_n_k 'signature(object = "vignetteCode",pos="numeric")':
          Returns the 'codeChunk' object representing the specified
          code chunk position 

     _n_u_m_C_h_u_n_k_s 'signature(object = "vignetteCode")': Returns the number
          of chunks in the object 

     _v_i_g_P_a_c_k_a_g_e 'signature(object = "vignetteCode")': Returns the
          package the vignette is a part of 

     _p_a_t_h 'signature(object = "vignetteCode")': Returns the local file
          path to the vignette 

     _s_e_t_C_h_u_n_k<- 'signature(object = "vignetteCode",pos="numeric",
          value="character")': Resets the code chunk specified by 'pos'
          to contain the code specified  by 'value' 

     _s_u_m_m_a_r_y 'signature(object = "vignetteCode")': A less verbose
          output of information then with 'show' 

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'Sweave', 'getVignetteCode', 'editVignetteCode', 'chunkList'