getDataMatrix: Retrieve data from the observations database

Description

getDataValues allows to query data from the database.

getDataMatrix obtaines data for a certain variable for all sites.

getDataVersions displays all the versions available in the database.

Usage

getDataValues(ID = NULL, from = NULL, to = NULL,
		 tz=c("global", "UTC", "GMT", "0", "local"), Site = NULL,
                 Variable = NULL, Offset = NULL, OffsetType = NULL,
                 CensorCode = NULL, Qualifier = NULL, Method = NULL,
                 Source = NULL, Sample = NULL, DerivedFromID = NULL,
                 QualityControlLevel = NULL, VersionID = NULL,
                 VersionDate = NULL, show.deleted = FALSE, 
		 all.ID = FALSE)
getDataMatrix(variables, aggregate, select.time = "latest",  warn.missing = FALSE)
getDataVersions()

Arguments

Unique ID of the DataValue

from

Starting date of the period for which to retrieve the information

End date of the period for which to retrieve the information

String indicating whether the data should be obtained in the local or global time zone.

Site

Information about the Site at which the data was observed.

Variable

Information about what variable was observed.

Offset

Information about the offset of the observation. See also OffsetType.

OffsetType

Information about the type of the offset as defined in the OffsetTypes table. See also addOffsetType.

CensorCode

Information about the cesor used for the observation.

Qualifier

Qualifying information that can note anything unusual or problematic about individual observations such as, for example, 'holding time for analysis exceeded' or 'incomplete or inexact daily total.'

Method

The method of field data collection, which may specify 'how' a physical observation was made or collected

Source

Reference to the original sources of the data, providing information sufficient to retrieve and reconstruct the data value from the original data files

Sample

Information about physical samples analyzed in a laboratory to obtain an observation.

DerivedFromID

Reference to another record in the database, from which a value was derived.

QualityControlLevel

Level of quality controlled applied to a dataset.

VersionID

Data version to be retrieved (see details about version management)

VersionDate

Creation date of the version to be retrieved (see details about version management)

show.deleted

Include records that have been deleted (see details about version management)

variables

name of the variables for which to retrieve a data matrix.

aggregate

aggregation function to aggregate multiple values in DataMatrix. Only used if select.time = NULL

select.time

POSIX time object: What point in time should be used to fill the DataMatrix?

warn.missing

Boolean indicating if missing information should be reported.

all.ID

Boolean: Can the function assume that all values are passed as ID. Reduces number of Database queries. Do not use normally, mainly for internal use.

Value

ToDo: describe return values

Details

ToDo: Details about Version Management What do you want to know in addition?

Examples

Run this code

getDefaultDB()

#Put data into the database
example(addDataValues)

# Get a list of available variables with ID's)
getMetadata("Variable")$Name 

# Get ID of variable of interest 
var.id <- getID("Variable", "Distance") 

# Get data
data <- getDataValues(Variable="Distance", Site="test site") 
	# returns data object of class 'observations' with 4 slots

# Get data values:
data@values #returns data object of class 'xts'