Describe the columns of an OmicIDX table

Usage

omicidx_describe(con, table)

Arguments

con: A connection from omicidx_connect(), or an omicidx_db() object.
table: character(1). A table name, schema-qualified as in "sradb.study". Unqualified names are looked up in main.

Value

A tibble with one row per column: column_name, column_type and null (whether the column may hold NULLs).

Examples

con <- omicidx_connect()
omicidx_describe(con, "sradb.study")
#> # A tibble: 14 × 3
#>    column_name          column_type null 
#>    <chr>                <chr>       <chr>
#>  1 study_id             BIGINT      YES  
#>  2 study_alias          VARCHAR     YES  
#>  3 study_accession      VARCHAR     YES  
#>  4 study_title          VARCHAR     YES  
#>  5 study_type           VARCHAR     YES  
#>  6 study_abstract       VARCHAR     YES  
#>  7 broker_name          VARCHAR     YES  
#>  8 center_name          VARCHAR     YES  
#>  9 center_project_name  VARCHAR     YES  
#> 10 study_description    VARCHAR     YES  
#> 11 study_attribute      VARCHAR     YES  
#> 12 bioproject_accession VARCHAR     YES  
#> 13 geo_accession        VARCHAR     YES  
#> 14 pubmed_ids           VARCHAR[]   YES  
DBI::dbDisconnect(con)