Last updated: 2024-07-26

Checks: 7 0

Knit directory: muse/

This reproducible R Markdown analysis was created with workflowr (version 1.7.1). The Checks tab describes the reproducibility checks that were applied when the results were created. The Past versions tab lists the development history.


Great! Since the R Markdown file has been committed to the Git repository, you know the exact version of the code that produced these results.

Great job! The global environment was empty. Objects defined in the global environment can affect the analysis in your R Markdown file in unknown ways. For reproduciblity it’s best to always run the code in an empty environment.

The command set.seed(20200712) was run prior to running the code in the R Markdown file. Setting a seed ensures that any results that rely on randomness, e.g. subsampling or permutations, are reproducible.

Great job! Recording the operating system, R version, and package versions is critical for reproducibility.

Nice! There were no cached chunks for this analysis, so you can be confident that you successfully produced the results during this run.

Great job! Using relative paths to the files within your workflowr project makes it easier to run your code on other machines.

Great! You are using Git for version control. Tracking code development and connecting the code version to the results is critical for reproducibility.

The results in this page were generated with repository version a9be34e. See the Past versions tab to see a history of the changes made to the R Markdown and HTML files.

Note that you need to be careful to ensure that all relevant files for the analysis have been committed to Git prior to generating the results (you can use wflow_publish or wflow_git_commit). workflowr only checks the R Markdown file, but you know if there are other scripts or data files that it depends on. Below is the status of the Git repository when the results were generated:


Ignored files:
    Ignored:    .Rhistory
    Ignored:    .Rproj.user/
    Ignored:    r_packages_4.3.3/
    Ignored:    r_packages_4.4.0/

Unstaged changes:
    Modified:   script/run_rstudio.sh

Note that any generated files, e.g. HTML, png, CSS, etc., are not included in this status report because it is ok for generated content to have uncommitted changes.


These are the previous versions of the repository in which changes were made to the R Markdown (analysis/dbi.Rmd) and HTML (docs/dbi.html) files. If you’ve configured a remote Git repository (see ?wflow_git_remote), click on the hyperlinks in the table below to view the files as they were in that past version.

File Version Author Date Message
Rmd a9be34e Dave Tang 2024-07-26 Connect to SQLite and make some basic queries
html 6917788 Dave Tang 2024-07-17 Build site.
Rmd bb8ad42 Dave Tang 2024-07-17 Database basics

Introduction

The {DBI} package provides:

A database interface definition for communication between R and relational database management systems. All classes in this package are virtual and need to be extended by the various R/DBMS implementations.

A database table can be thought of as a data frame, however there are three high-level differences between them:

  1. Database tables are stored on disk and can be arbitrarily large, whereas data frames are stored in memory and are fundamentally limited.

  2. Database tables almost always have indexes making it possible to quickly find rows of interest without having to look at every single row. Data frames don’t have indexes but data tables do, which is one of the reasons why they’re so fast.

  3. Most classical databases are optimised for rapidly collecting data and not for analysing existing data. These databases are called row-oriented because the data is stored row by row, rather than column by column like data frames. More recently, there’s been much development of column-oriented databases that make analysing existing data much faster.

Databases are run by database management systems (DBMS), which come in three basic forms:

  1. Client-server DBMS run on a powerful central server, which you connect from your computer (the client). They are useful for sharing data with multiple people and popular client-server DBMS include PostgreSQL, MariaDB, SQL Server, and Oracle.

  2. Cloud DBMS, like Snowflake, Amazon’s RedShift, and Google’s BigQuery, are similar to client-server DBMS, but they run in the cloud, taking advantage of cloud capabilities.

  3. In-process DBMS, like SQLite or duckdb, run entirely on your computer. They’re great for working with large datasets where you are the primary user.

Connecting to a database

To connect to a database in R, we need:

  1. The DBI package because it provides a set of generic functions that connect to the database.
  2. A specific package tailored for the DBMS of interest; this package translates the generic DBI commands into the specifics.

The {RSQLite} package provides a SQLite interface for R.

Embeds the SQLite database engine in R and provides an interface compliant with the DBI package. The source for the SQLite engine and for various extensions in a recent version is included. System libraries will never be consulted because this package relies on static linking for the plugins it includes; this also ensures a consistent experience across all installations.

SQLite database downloaded as per the post Interfacing with the Sequence Read Archive in R.

dbfile <- "/data2/sradb/SRAmetadb.sqlite"
mydb <- dbConnect(RSQLite::SQLite(), dbname = dbfile)
mydb
<SQLiteConnection>
  Path: /data2/sradb/SRAmetadb.sqlite
  Extensions: TRUE

DBI basics

Lists all tables in the database.

tabs <- dbListTables(mydb)
tabs
 [1] "col_desc"        "experiment"      "metaInfo"        "run"            
 [5] "sample"          "sra"             "sra_ft"          "sra_ft_content" 
 [9] "sra_ft_segdir"   "sra_ft_segments" "study"           "submission"     

Neat trick to get the fields of a table.

get_fields <- "SELECT * FROM run WHERE 1=0"
DBI::dbGetQuery(mydb, get_fields)
 [1] run_ID               bamFile              run_alias           
 [4] run_accession        broker_name          instrument_name     
 [7] run_date             run_file             run_center          
[10] total_data_blocks    experiment_accession experiment_name     
[13] sra_link             run_url_link         xref_link           
[16] run_entrez_link      ddbj_link            ena_link            
[19] run_attribute        submission_accession sradb_updated       
<0 rows> (or 0-length row.names)

Save all table fields.

table_fields <- purrr::map(tabs, \(x){
  sql <- paste0('SELECT * FROM ', x, ' WHERE 1=0')
  DBI::dbGetQuery(mydb, sql)
})

names(table_fields) <- tabs
table_fields[[1]]
[1] col_desc_ID   table_name    field_name    type          description  
[6] value_list    sradb_updated
<0 rows> (or 0-length row.names)

Disconnect.

DBI::dbDisconnect(mydb)

sessionInfo()
R version 4.4.0 (2024-04-24)
Platform: x86_64-pc-linux-gnu
Running under: Ubuntu 22.04.4 LTS

Matrix products: default
BLAS:   /usr/lib/x86_64-linux-gnu/openblas-pthread/libblas.so.3 
LAPACK: /usr/lib/x86_64-linux-gnu/openblas-pthread/libopenblasp-r0.3.20.so;  LAPACK version 3.10.0

locale:
 [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
 [3] LC_TIME=en_US.UTF-8        LC_COLLATE=en_US.UTF-8    
 [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8   
 [7] LC_PAPER=en_US.UTF-8       LC_NAME=C                 
 [9] LC_ADDRESS=C               LC_TELEPHONE=C            
[11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       

time zone: Etc/UTC
tzcode source: system (glibc)

attached base packages:
[1] stats     graphics  grDevices utils     datasets  methods   base     

other attached packages:
 [1] lubridate_1.9.3 forcats_1.0.0   stringr_1.5.1   dplyr_1.1.4    
 [5] purrr_1.0.2     readr_2.1.5     tidyr_1.3.1     tibble_3.2.1   
 [9] ggplot2_3.5.1   tidyverse_2.0.0 dbplyr_2.5.0    RSQLite_2.3.7  
[13] DBI_1.2.3       workflowr_1.7.1

loaded via a namespace (and not attached):
 [1] sass_0.4.9        utf8_1.2.4        generics_0.1.3    stringi_1.8.4    
 [5] hms_1.1.3         digest_0.6.35     magrittr_2.0.3    timechange_0.3.0 
 [9] evaluate_0.24.0   grid_4.4.0        fastmap_1.2.0     blob_1.2.4       
[13] rprojroot_2.0.4   jsonlite_1.8.8    processx_3.8.4    whisker_0.4.1    
[17] ps_1.7.6          promises_1.3.0    httr_1.4.7        fansi_1.0.6      
[21] scales_1.3.0      jquerylib_0.1.4   cli_3.6.2         rlang_1.1.4      
[25] munsell_0.5.1     bit64_4.0.5       withr_3.0.0       cachem_1.1.0     
[29] yaml_2.3.8        tools_4.4.0       tzdb_0.4.0        memoise_2.0.1    
[33] colorspace_2.1-0  httpuv_1.6.15     vctrs_0.6.5       R6_2.5.1         
[37] lifecycle_1.0.4   git2r_0.33.0      fs_1.6.4          bit_4.0.5        
[41] pkgconfig_2.0.3   callr_3.7.6       gtable_0.3.5      pillar_1.9.0     
[45] bslib_0.7.0       later_1.3.2       glue_1.7.0        Rcpp_1.0.12      
[49] xfun_0.44         tidyselect_1.2.1  rstudioapi_0.16.0 knitr_1.47       
[53] htmltools_0.5.8.1 rmarkdown_2.27    compiler_4.4.0    getPass_0.2-4