R/rEHR_functions.R

In rcprd: Extraction and Management of Clinical Practice Research Datalink Data

#' Open connection to SQLite database
#'
#' @description
#' Open connection to SQLite database
#'
#' @param dbname Name of SQLite database on hard disk (including full file path relative to working directory)
#'
#' @returns No return value, called to open a database connection.
#'
#' @examples
#'
#' ## Connect to a database
#' aurum_extract <- connect_database(file.path(tempdir(), "temp.sqlite"))
#'
#' ## Check connection is open
#' inherits(aurum_extract, "DBIConnection")
#'
#' ## clean up
#' RSQLite::dbDisconnect(aurum_extract)
#' unlink(file.path(tempdir(), "temp.sqlite"))
#'
#' @export
connect_database <- function(dbname){
  if(!stringr::str_detect(dbname, "\\.sqlite$")) {
    dbname <- paste(dbname, "sqlite", sep = ".")
  }
  RSQLite::dbConnect(RSQLite::SQLite(), dbname)
}