arealDB (version 0.3.9)

setPath: Set the root path

Description

Initiate a geospatial database or register a database that exists at the root path.

Usage

setPath(root = NULL)

Arguments

root

[character(1)] path to the root directory that contains or shall contain an areal database.

Value

No return value, called for the side effect of creating the directory structure of the new areal database and a new environment that contains the database metadata.

Details

This is the first function that is run in a project, as it initiates the areal database by creating the default sub-directories and initial inventory tables. When a database has already been set up, this function is used to register that path in the options of the current R session.

Examples

# NOT RUN {
setPath(root = paste0(tempdir(), "/newDB"))
# }