reportDB: A function report data

In ProfoundData: Downloading and Exploring Data from the PROFOUND Database

Description

This functions creates a site-by-site report of all avalaible data in the PROFOUND database. The summary is created with a rmarkdown document, which is rendered and saved as a html document.

Usage

reportDB(outDir = NULL)

Arguments

outDir

a character string indicating the output directory in which the html file will be saved. If no value is provided, the working directory will be used as output directory.

Details

Please note that creating the report it might take several minutes.

Value

a html file with the database report

Note

To report errors in the package or the data, please use the issue tracker in the GitHub repository of ProfoundData https://github.com/COST-FP1304-PROFOUND/ProfoundData

Examples

# example requires that a sql DB is registered via setDB(dbfile)
# when run without a registered DB, you will get a file query (depending on OS)

## Not run: 
reportDB(outDir = tempdir())

## End(Not run)

ProfoundData documentation built on March 31, 2020, 5:24 p.m.