getYearlyField_aDGVM: Get a yearly aDGVM Field

View source: R/Format-aDGVM.R

getYearlyField_aDGVMR Documentation

Get a yearly aDGVM Field

Description

from the run (eg. "lai", to read the file "lai.out") and Source object which defines where the run is on disk and the offsets to apply

Usage

getYearlyField_aDGVM(
  run,
  quant,
  target.sta,
  file.name = file.name,
  verbose = FALSE,
  data.table.only = FALSE,
  adgvm.fire = 1,
  adgvm.climate = 0,
  adgvm.header,
  ...
)

Arguments

run

A Source containing the meta-data about the aDGVM run

quant

A Quant to define what output file from the aDGVM run to open, can also be a simple string defining the aDGVM output file if the return.data.table argument is TRUE

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

data.table.only

A logical, if TRUE return a data.table and not a Field

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

Details

Note that the files can be gzipped on UNIX systems, but this might fail on windows systems.

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.