hguatlas13k_dbconn {hguatlas13k.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

      hguatlas13k_dbconn()
      hguatlas13k_dbfile()
      hguatlas13k_dbschema(file="", show.indices=FALSE)
      hguatlas13k_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

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

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

`hguatlas13k_dbschema` prints the schema definition of the package annotation DB.

`hguatlas13k_dbInfo` prints other information about the package annotation DB.

### Value

`hguatlas13k_dbconn`: a DBIConnection object representing an open connection to the package annotation DB.
`hguatlas13k_dbfile`: a character string with the path to the package annotation DB.
`hguatlas13k_dbschema`: none (invisible `NULL`).
`hguatlas13k_dbInfo`: none (invisible `NULL`).

### See Also

`dbGetQuery`, `dbConnect`, `dbconn`, `dbfile`, `dbschema`, `dbInfo`

### Examples

      ## Count the number of rows in the "probes" table:
      dbGetQuery(hguatlas13k_dbconn(), "SELECT COUNT(*) FROM probes")

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

      hguatlas13k_dbschema()

      hguatlas13k_dbInfo()

[Package hguatlas13k.db version 2.2.0 Index]