utils                 package:stashR                 R Documentation

_S_e_t _d_i_r_e_c_t_o_r_y _f_o_r _r_e_m_o_t_e _d_a_t_a_b_a_s_e

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

     Utilities for '"localDB"' and '"remoteDB"' databases

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

     setDir(db) <- value
     copyDB(db, ...)
     reposVersion(db, ...)
     reposVersion(db) <- value

     ## S4 method for signature 'localDB':
     initialize(.Object, ...)
     ## S4 method for signature 'remoteDB':
     initialize(.Object, ...)

     ## S4 method for signature 'localDB':
     copyDB(db, dir, ...)

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

      db: an object of class '"remoteDB"' or '"localDB"'

   value: character, directory to be assigned

 .Object: an object of class '"localDB"' or '"remoteDB"'

     dir: directory into which the '"localDB"' should be copied

     ...: other arguments passed to methods

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

     Users obtaining '"remoteDB"' objects created on different machines
     may want to reset the directory specified for the local cache. 
     The 'setDir' replacement function is to be used for that purpose.

     Users generally will not call the 'initialize' functions directly,
     but rather will call them indirectly via the 'new' function.

     'copyDB' is used to copy a '"localDB"' database to another
     location (i.e. directory).

     'reposVersion' returns the current repository version number and
     the replacement method can be used to set the repository to a
     different version number.  A repository version of '-1' indicates
     the most recent version.

