chunkList-class            package:DynDoc            R Documentation

_C_l_a_s_s "_c_h_u_n_k_L_i_s_t"

_D_e_s_c_r_i_p_t_i_o_n:

     This class is essentially a wrapper for the 'codeChunk' class.  It
     contains all of the 'codeChunks' from a vignette file.

_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("chunkList",
     ...)'.

_S_l_o_t_s:

     '_c_h_u_n_k_s': Object of class '"list"' Stores a list of 'codeChunk'
          objects, representing all of the code chunks from a vignette
          file.

_M_e_t_h_o_d_s:

     _s_h_o_w 'signature(object = "chunkList")': Displays verbose
          information about the code chunks

     _c_h_u_n_k_s 'signature(object = "chunkList")':  Retrieves a list of
          'codeChunk' objects

     _g_e_t_A_l_l_C_o_d_e_C_h_u_n_k_s 'signature(object = "chunkList")': Collapses all
          of the code chunks into one block of code and returns this

     _g_e_t_C_h_u_n_k 'signature(object = "chunkList")': Retrieves a specific
          code chunk

     _n_u_m_C_h_u_n_k_s 'signature(object = "chunkList")': Returns the number of
          code chunks in this object

     _s_e_t_C_h_u_n_k<- 'signature(object = "chunkList", value="character")':
          Changes the code in a given 'codeChunk' contained by this
          object 

     _s_u_m_m_a_r_y 'signature(object = "chunkList")': A less verbose display
          of information about the object

     _e_v_a_l_C_h_u_n_k 'signature(object = "chunkList", pos="numeric")':
          Evaluates the code chunk at the specified position in the
          'chunkList' object

_A_u_t_h_o_r(_s):

     Jeff Gentry

_S_e_e _A_l_s_o:

     'Sweave', 'codeChunk', 'vignetteCode'

_E_x_a_m_p_l_e_s:

         library("utils")
         testfile <- system.file("Sweave", "Sweave-test-1.Rnw", package="utils")
         z <- Stangle(testfile,driver=tangleToR)

