getStandardQuantity_aDGVM: Returns the data from one aDGVM output variable as a...

View source: R/Format-aDGVM.R

getStandardQuantity_aDGVMR Documentation

Returns the data from one aDGVM output variable as a data.table.

Description

This function can retrieve a 'Standard' vegetation quantity (returned as a data.table) with standard definition and units to compare to other models and to data. This must be implemented for each and every Standard quantity for each and every model to ensure completeness.

Usage

getStandardQuantity_aDGVM(
  run,
  quant,
  target.sta,
  file.name = file.name,
  adgvm.file.type,
  verbose = FALSE,
  ...
)

Arguments

run

A Source containing the meta-data about the aDGVM run from which the data is to be read. Most importantly it must contain the run.dara nd the offsets.

quant

A Quantity to define what output file from the aDGVM run to open

file.name

An optional character string (or a list of character strings) holding the name of the file(s) This can be left blank, in which case the file name is automatically generated.

verbose

A logical, set to true to give progress/debug information

first.year

The first year (as a numeric) of the data to be return

last.year

The last year (as a numeric) of the data to be return

Value

a data.table (with the correct tear offset and lon-lat offsets applied)

Author(s)

Matthew Forrest matthew.forrest@senckenberg.de

Glenn Moncrieff glenn@saeon.ac.za


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