availableQuantities: List available quantities

In MagicForrest/DGVMTools: DGVM Processing, Analysis and Plotting Tools

List available quantities

Description

This function looks at the files on disk associated with a Source object (reminder, a Source representrsis a particular dataset or model run) and determines what Quantities are available. The data for these Quanties can be read by getField()

Usage

availableQuantities(source, names = TRUE, ...)

Arguments

source	The DGVMTools::Source object for which the avaiable variables are to be determined.
names	Logical, if TRUE (default) return the ids of the DGVMTools::Quantity objects, otherwise return the Quantity objects themselves.
...	Other arguments that are passed to the getField function for the specific Format. Currently this is only 'adgvm.scheme' (for the aDGVM Format) which can be 1 or 2.

Details

This exact behaviour of this function will depend on the Format of the Source object. Different Format objects have different implementations of availableQuantites() because the files and file structure of each Format are, by definition, different.

Value

A list of the available Quantites.

Author(s)

Matthew Forrest [e-mail]

Examples

 
# Define an example Source
test.dir <- system.file("extdata", "LPJ-GUESS_Runs", "CentralEurope", package = "DGVMTools")
test.Source <- defineSource(name = "LPJ-GUESS", dir = test.dir,  format = GUESS)

# list the available Quantities as list of ids
availableQuantities(test.Source)

# list the available Quantities as list of Quantity objects
availableQuantities(test.Source, names = FALSE)

MagicForrest/DGVMTools documentation built on Aug. 23, 2024, 8:05 a.m.