run_objective: Run user-specified objective function evaluations on a list...
In JGCRI/gcamland: GCAM Land Allocation Module

Description Usage Arguments Details Value Author(s)

The assumption is that the scenarios have already been run. The best way to arrange this is to use the return value of run_ensemble as the argument to this function

run_objective(
  aScenarioList,
  years = NULL,
  landtypes = NULL,
  objectivefuns = c("bias", "rms", "centeredrms", "nrms", "centerednrms", "kge")
)

`aScenarioList`	List of ScenarioInfo structures
`years`	Vector of years to filter observations to (default is to use all available years)
`landtypes`	Vector of land types to filter observations to (default is to use all available land types). Currently, this is crop-type GCAM commodities with observations from FAO via the `get_historical_land_data` function. TODO: update to include choice of data sources and other land types, eg Forest.
`objectivefuns`	User specified string of objective functions to calculate. Default is to all supported objective functions: c('bias', 'rms', 'centeredrms', 'nrms', 'centerednrms', 'kge')).

The years and landtypes arguments can be use to restrict the observations that will be used in the analysis. The regions are always filtered to excatly the regions that are included in the ScenarioInfo structures. The objectivefuns is vector of strings with the names of objective functions to be evaluated. Currently, we support the following objective functions: c('bias', 'rms', 'centeredrms', 'nrms', 'centerednrms', 'kge')

c('bias', 'rms', 'centeredrms', 'nrms', 'centerednrms' are defined and examined in Snyder et al 2017 (https://doi.org/10.5194/gmd-10-4307-2017), among other places.

The definition for 'kge' presented in Knoben et al 2019 (https://doi.org/10.5194/hess-23-4323-2019) is the one implemented here.

Modified list of ScenarioInfo structures with the objective function calculation tables populated as a new list entry in ScenarioInfo: ScenarioInfo$mObjFunEval.

ACS May 2020

JGCRI/gcamland documentation built on Oct. 6, 2020, 5:30 p.m.