update_scen_info: update_scen_info

In JGCRI/gcamland: GCAM Land Allocation Module

Description

This function takes the default SCENARIO.INFO object and updates it based on user specified arguments. Some updates (e.g., changing from "Reference" to "Hindcast" scenario type) will automatically update the scenario name and file name.

Usage

update_scen_info(
  aName = NULL,
  aScenarioType = DEFAULT.SCENARIO.TYPE,
  aExpectationType = "Perfect",
  aLinearYears = NULL,
  aLinearYears1 = NULL,
  aLinearYears2 = NULL,
  aLinearYears3 = NULL,
  aLaggedShareOld = NULL,
  aLaggedShareOld1 = NULL,
  aLaggedShareOld2 = NULL,
  aLaggedShareOld3 = NULL,
  aUseZeroCost = FALSE,
  aCalibrateShareWt = TRUE,
  aIncludeSubsidies = FALSE,
  aShareWts = NULL
)

Arguments

aName	New scenario name (default will generate this from other info)
aScenarioType	New scenario type (default = DEFAULT.SCENARIO.TYPE)
aExpectationType	New expectation type (default = "Perfect")
aLinearYears	New linear years (default = NULL)
aLinearYears1	New linear years for crop group 1 (see constants.R) (default = NULL)
aLinearYears2	New linear years for crop group 2 (see constants.R) (default = NULL)
aLinearYears3	New linear years for crop group 3 (see constants.R) (default = NULL)
aLaggedShareOld	New lagged share old (default = NULL)
aLaggedShareOld1	New lagged share old (group 1) (see constants.R) (default = NULL)
aLaggedShareOld2	New lagged share old (group 2) (see constants.R) (default = NULL)
aLaggedShareOld3	New lagged share old (group 3) (see constants.R) (default = NULL)
aUseZeroCost	New cost assumption (default = FALSE)
aCalibrateShareWt	Flag indicating share weights should be calibrated
aIncludeSubsidies	Flag indicating subsidies should be added to profit
aShareWts	Vector of share weights

Value

Updated scenario info object

Author(s)

KVC November 2018

Examples

update_scen_info(aCalibrateShareWt = FALSE, aShareWts=get_saved_share_weights())
update_scen_info(aScenarioType = "Hindcast")

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