cacheSweave           package:cacheSweave           R Documentation

_C_a_c_h_e _S_w_e_a_v_e _C_o_m_p_u_t_a_t_i_o_n_s

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

     Cache computations when using Sweave

_U_s_a_g_e:

     cacheSweaveDriver()

_D_e_t_a_i_l_s:

     Computations in Sweave documents can be cached by setting the
     option 'cache=true' in the code check declaration.  When this
     option is set, objects that are created in the code chunk (either
     through assignment or by side effects) are stored in a key-value
     database in the directory specified by 'setCacheDir'.

     The 'cacheSweaveDriver' function is used directly with 'Sweave'
     and is passed as the 'driver' argument. 'cacheSweaveDriver' also
     creates a "map file" which has the extention ".map" which contains
     metadata for each of the code chunks in a document.  This map file
     can be used in conjunction with the 'RRPM' package for creating
     reproducible research packages.

_V_a_l_u_e:

     Nothing useful is returned.

_N_o_t_e:

     Code chunks that have side effects that do not result in objects
     being created in the global environment (i.e. plotting or system
     interaction) should generally not be cached since the code will
     not be run upon reevaluation.

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

     Roger D. Peng rpeng@jhsph.edu, with much code for
     'cacheSweaveDriver' copied from Sweave source by Friedrich Leisch

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

     'Sweave' and package 'RRPM'

