dbInit               package:filehash               R Documentation

_S_i_m_p_l_e _f_i_l_e-_b_a_s_e_d _h_a_s_h _t_a_b_l_e

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

     Interface for creating and initializing a simple file-based hash
     table

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

     dbCreate(db, ...)
     dbInit(db, ...)
     dbReconnect(db, ...)

     ## S4 method for signature 'ANY':
     dbCreate(db, type = NULL, ...)
     ## S4 method for signature 'ANY':
     dbInit(db, type = NULL, ...)
     ## S4 method for signature 'filehashDB1':
     dbReconnect(db, ...)

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

      db: name of database or a database object

    type: type of database format.  If missing, the default type will
          be used

     ...: other arguments passed to methods

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

     'dbCreate' creates the necessary files or directory for the
     database.  If those files already exist nothing is done.

     'dbInit' takes a database name and returns an object inheriting
     from class '"filehash"'.

     The 'type' argument specifies the format in which the database
     should be stored on the disk.  If not specified, the default type
     will be used (as specified by 'filehashOption').

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

     'dbCreate' returns 'TRUE' upon success and 'FALSE' in the event of
     an error.  'dbInit' returns an object inheriting from class
     '"filehash"'

_N_o_t_e:

     The function 'dbInitialize' has been deprecated.  Use 'dbInit'
     instead.

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

     Roger D. Peng

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

     See 'filehash-class' more information and examples and
     'filehashOption' for setting the default database type.

