raw.getDatabase: Manage SQL Database with Data Package

View source: R/raw.getDatabase.R

raw.getDatabaseR Documentation

Manage SQL Database with Data Package

Description

Some data packages require large amounts of data (1 - 10GB), which cannot be stored in the 'extdata' folder directly, since the install would take too long. If data exceeds about 10 MB, then RDA files become inefficient, and an SQL database makes sense. For AFM data, you can use AFM.writeDB() for example.

The database needs to be stored in the 'extdata' and also needs to be version controlled. This function helps manage this process. The data package generates the small RDA data files and puts the large data files into the SQL databse that is stored in the main directory of the database. The database needs to store at least one more dummy file in the 'inst/extdata' folder, so that this folder is generated and loaded.

When called with the 'pkgname', the function uses the version to generate the database filename and return its path.

Usage

raw.getDatabase(pkgname, dbPath = NULL, verbose = FALSE)

Arguments

pkgname

name of the R data package

dbPath

path

verbose

logical, additional information

Value

SQL database filename and path


thomasgredig/RAWdataR documentation built on Nov. 6, 2024, 9:46 a.m.