arealDB (version 0.6.3)

makeExampleDB: Build an example database

Description

This function helps setting up an example database up until a certain step.

Usage

makeExampleDB(path = NULL, until = NULL, verbose = FALSE)

Value

No return value, called for the side effect of creating an example database at the specified path.

Arguments

path

[character(1)]
The database gets created by default in tempdir(), but if you want it in a particular location, specify that in this argument.

until

[character(1)]
The database building step in terms of the function names until which the example database shall be built, one of "start_arealDB", "regDataseries", "regGeometry", "regTable", "normGeometry" or "normTable".

verbose

[logical(1)]
be verbose about building the example database (default FALSE).

Details

Setting up a database with an R-based tool can appear to be cumbersome and too complex and thus intimidating. By creating an example database, this functions allows interested users to learn step by step how to build a database of areal data. Moreover, all functions in this package contain verbose information and ask for information that would be missing or lead to an inconsistent database, before a failure renders hours of work useless.

Examples

if(dev.interactive()){
# to build the full example database
makeExampleDB(path = paste0(tempdir(), "/newDB"))

# to make the example database until a certain step
makeExampleDB(path = paste0(tempdir(), "/newDB"), until = "regDataseries")

}