homolog_dbconn          package:homolog.db          R Documentation

_C_o_l_l_e_c_t _i_n_f_o_r_m_a_t_i_o_n _a_b_o_u_t _t_h_e _p_a_c_k_a_g_e _a_n_n_o_t_a_t_i_o_n _D_B

_D_e_s_c_r_i_p_t_i_o_n:

     Some convenience functions for getting a connection object to (or
     collecting  information about) the package annotation DB.

_U_s_a_g_e:

       homolog_dbconn()
       homolog_dbfile()
       homolog_dbschema(file="", show.indices=FALSE)
       homolog_dbInfo()

_A_r_g_u_m_e_n_t_s:

    file: A connection, or a character string naming the file to print
          to  (see the file argument of the cat function for the
          details). 

show.indices: The CREATE INDEX statements are not shown by default. Use
           show.indices=TRUE to get them. 

_D_e_t_a_i_l_s:

     'homolog_dbconn' returns a connection object to the package
     annotation DB.  IMPORTANT: Don't call 'dbDisconnect' on the
     connection object  returned by 'homolog_dbconn' or you will break
     all the  'AnnDbObj' objects defined in this package! 

     'homolog_dbfile' returns the path (character string) to the
     package annotation DB (this is an SQLite file). 

     'homolog_dbschema' prints the schema definition of the package
     annotation DB. 

     'homolog_dbInfo' prints other information about the package
     annotation DB.

_E_x_a_m_p_l_e_s:

       ## Show the first three rows.
       dbGetQuery(homolog_dbconn(), "select * from homolog limit 3")

       ## The connection object returned by homolog_dbconn() was created with:
       dbConnect(SQLite(), dbname=homolog_dbfile(), cache_size=64000, synchronous=0)

       homolog_dbschema()

       homolog_dbInfo()

