saveCache              package:R.cache              R Documentation

_S_a_v_e_s _d_a_t_a _t_o _f_i_l_e _c_a_c_h_e

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

     Saves data to file cache, which is unique for an optional key
     object.

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

     ## Default S3 method:
     saveCache(object, key=NULL, sources=NULL, suffix=".Rcache", comment=NULL, dirs=NULL, ...)

_A_r_g_u_m_e_n_t_s:

  object: The object to be saved to file.

     key: An optional object from which a hexadecimal hash code will be
          generated and appended to the filename.

 sources: Source objects used for comparison of timestamps when cache
          is loaded later.

  suffix: A 'character' string to be appended to the end of the
          filename.

 comment: An optional 'character' string written in ASCII at the
          beginning of the file.

    dirs: A 'character' 'vector' constituting the path to the cache
          subdirectory to be used. If 'NULL', the root path is used.

     ...: Additional argument passed to 'save'().

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

     Returns (invisible) the pathname of the cache file.

_R_e_q_u_i_r_e_m_e_n_t_s:

     To make use of the 'key' argument, the _digest_ package (available
     on CRAN) must be installed, otherwise an error is generated. That
     package is not required when 'key==NULL'.

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

     Henrik Bengtsson (<URL: http://www.braju.com/R/>)

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

     For more details on how the hash code is generated etc,
     'loadCache'().

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

     ## Not run: For an example, see ?loadCache

