dataInventory: Dataset inventory

In SantanderMetGroup/loadeR: A climate4R package for data access <http://meteo.unican.es/climate4r>

Dataset inventory

Description

Function to provide a quick overview of a climate dataset (either stations or gridded data)

Usage

dataInventory(dataset, return.stats = FALSE)

Arguments

dataset	A character string poiting to the target. Either a directory containing the data in the case of station data in standard ASCII format (see loadStationData) for details), or a target file (a NcML) in the case of other types of gridded data (reanalysis, gridded observations ..., see loadGridData for details).
return.stats	Optional logical flag indicating if summary statistics of the dataset should be returned with the inventory. Only used for station data.

Value

A list of components describing the variables and other characteristics of the target dataset.

Note

The variable names returned correspond to the original names of the variables as stored in the dataset, and not to the standard naming convention defined in the vocabulary.

Author(s)

J Bedia

See Also

stationInfo for a quick overview of available stations in station datasets. Further details are given in scanVarDimensions, which is the internal performing the dimension info retrieval.

Examples

## Not run: 
dir.create("mydirectory")
download.file("http://meteo.unican.es/work/loadeR/data/VALUE_ECA_86_v2.tar.gz", 
              destfile = "mydirectory/VALUE_ECA_86_v2.tar.gz")
# Extract files from the tar.gz file
untar("mydirectory/VALUE_ECA_86_v2.tar.gz", exdir = "mydirectory")
# Data inventory
value <- "mydirectory/VALUE_ECA_86_v2"
di <- dataInventory(value)
str(di)
# To obtain summary statistics of the variables stored:
di.stats <- dataInventory(value, return.stats = TRUE)
print(di.stats$Summary.stats)

## End(Not run) 

SantanderMetGroup/loadeR documentation built on June 7, 2024, 8:16 p.m.