columnDescriptions: Get column descriptions for the GEOmetadb database
In zhujack/GEOmetadb: A compilation of metadata from NCBI GEO

columnDescriptions

R Documentation

Get column descriptions for the GEOmetadb database

Description

Searching the GEOmetadb database requires a bit of knowledge about the structure of the database and column descriptions. This function returns those column descriptions for all columns in all tables in the database.

Usage

columnDescriptions(sqlite_db_name='GEOmetadb.sqlite')

Arguments

sqlite_db_name

The filename of the GEOmetadb sqlite database file

Value

A three-column data.frame including TableName, FieldName, and Description.

Author(s)

Sean Davis <sdavis2@mail.nih.gov>

Examples

## Use the demo GEOmetadb database:
if( !file.exists("GEOmetadb.sqlite") ) {
    demo_sqlfile <- getSQLiteFile(destdir = getwd(), destfile = "GEOmetadb.sqlite.gz", type = "demo")
} else {
    demo_sqlfile <- "GEOmetadb.sqlite"
}
columnDescriptions(demo_sqlfile)[1:5,]

## Download the full GEOmetadb database:
## Not run: geometadbfile <- getSQLiteFile()

zhujack/GEOmetadb documentation built on Oct. 26, 2022, 7:32 a.m.