ProfoundData-package {ProfoundData}

Overview of the functions in the ProfoundData package

Description

The ProfoundData R package provides functions to explore, visualize and get data from the PROFOUND database. The development of the PROFOUND database and the ProfoundData R package was faciliated by COST Action FP1304 PROFOUND.

A brief description of the PROFOUND database is avalaible in the vignette 'PROFOUNDdatabase' ( you can open it by running this command: vignette('PROFOUNDdatabase')).

Note: before you can use the package, you need to download the database via downloadDatabase and register the database location via setDB

Below is a list of the package's functions grouped by theme. See the package vignette for more information and examples (vignette('ProfoundData')).

I. Browse the database

Functions to explore the database.

• browseData To check

  • available sites

  • available datasets

  • available variables for a dataset

  • available datasets for a site

  • database version

  • metadata

  • policy

  • source

  • site description

• summarizeData To obtain

  • data overviews

  • data summaries

II. Extract data

Functions to extract data. Data can be extracted for one site and one dataset at a time.

• getData To extract data

III. Visualize data

Functions to plot data from the database.

• plotData To plot data

IV. Utilities

Miscellanous

• downloadDatabase To download the database

• setDB To set the connection to the database

• getDB To retrieve the filepath to the database

• queryDB To pass self-defined queries

• reportDB To create a site-by-site report of the database

• writeSim2netCDF To write netCDF-files

Author(s)

Except where indicated otherwise, the functions in this package were written by Ramiro Silveyra Gonzalez, Christopher Reyer, Florian Hartig and Mahnken. Ramiro Silveyra Gonzalez was the main developer of the package. Florian Hartig is currently the maintainer.