homolog_dbconn {homolog.db}R Documentation

Collect information about the package annotation DB

Description

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

Usage

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

Arguments

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.

Details

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.

Examples

  ## 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()
[Package homolog.db version 1.1.0 Index]