README.md

In KWB-R/kwb.db: Functions supporting data base access

kwb.db

This repository contains the R package kwb.db. The package provides functions that aim at simplifying the data transfer between databases and R. It is based on the RODBC package that gives access to databases that provide an ODBC interface. Databases may be Microsoft Access files, Microsoft Excel files or any other database that is registered as an ODBC data source on your local machine. See e.g. here for how to setup ODBC data sources in Windows.

For installing the latest release of this R package run the following code below:

# Enable repository from kwb-r
options(repos = c(
  kwbr = 'https://kwb-r.r-universe.dev',
  CRAN = 'https://cloud.r-project.org'))

# Download and install kwb.db in R
install.packages('kwb.db')

# Browse the kwb.swmm manual pages
help(package = 'kwb.db')

Database Access in RODBC

With the RODBC package, you need to open a database connection, send one or more requests to the database and finally close the dabase connection.

Database Access with this package

With the functions of this package it is not needed to open and close a database connection explicitly; this is done behind the scenes in the functions. Instead of a database connection the path to the database file needs to be passed to the functions as an argument.

The main functions are hsGetTable() and hsPutTable(). They transfer data from a database to a data frame in R and save data from a data frame in R into a new table in a database, respectively.

Use hsTables() to get a list of tables that are available in a database and hsFields() to get a list of table fields that are contained in a database table.

A general workflow could look like this:

# Define the path to a MS Access datbase file
mdb <- "/path/to/your/database.mdb"

# Have a look at what tables are contained in the database
(tables <- kwb.db::hsTables(mdb))

# For each table, get the vector of available fields (= columns)
lapply(tables, kwb.db::hsFields, mdb = mdb)

# Get the content of the first table
data <- kwb.db::hsGetTable(mdb, tables[1])

# Do some modifiactions or create somehow else a new data frame
data_new <- do_some_fancy_stuff(data)

# Save the new data frame as a new "fancy_table" in the database
kwb.db::hsPutTable(mdb, data_new, "fancy_table")

In each of the kwb.db::-function calls above a database connection is opened, a request to the database is sent and the connection is closed again. Thus, the user does not have to care about open database connections.

Take care when getting time series data from an MS Access database, see therefore hsMdbTimeSeries().

Documentation

Release: https://kwb-r.github.io/kwb.db

Development: https://kwb-r.github.io/kwb.db/dev

KWB-R/kwb.db documentation built on Oct. 1, 2023, 4:10 a.m.