makeFieldID: Make an ID string for a 'Field'

View source: R/makeFieldID.R

makeFieldIDR Documentation

Make an ID string for a Field

Description

Given a string for the quantity and temporal and spatial extents and averaging flags, build an appropriate (and unique) ID string for use in the id slot of a Fieldand for filenames etc.

Usage

makeFieldID(
  field,
  source,
  quant.string,
  sta.info,
  first.year,
  last.year,
  year.aggregate.method,
  subannual.resolution = NULL,
  spatial.aggregate.method = NULL,
  subannual.aggregate.method = NULL,
  spatial.extent.id = NULL,
  subannual.original = NULL
)

Arguments

quant.string

Character string to describe the Quantity, eg "lai" or "corrected.cmass" or "npp.diff"

first.year

The first year if it has been cropped from the original duration, otherwise NULL

last.year

The first year if it has been cropped from the original duration, otherwise NULL

year.aggregate.method

Character, method by which this Field was temporally aggregated (if not temporally averaged leave blank of use "none")

spatial.aggregate.method

Character, method by which this Field was spatially aggregated (if not spatially averaged leave blank of use "none")

spatial.extent.id

The spatial extent of this object if it has been cropped from the orginal simulation extent, otherwise NULL

Value

A character string

Author(s)

Matthew Forrest matthew.forrest@senckenberg.de


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