
Figure 1
Default nesting structure used in gcamland.

Figure 2
Sample land allocation by use and type in the USA for a Reference scenario.
Table 1
Table of the main methods in the gcamland v1.0 package, including their inputs and outputs. Note that only methods that can be called directly are listed in the table.
| Method | Description | Inputs | Output | |
|---|---|---|---|---|
| Name | Description | |||
| run_model | Calculates land use and land cover for a given region and set of time periods | aScenarioInfo | Scenario-related information, including names, logits, expectations. | Table of model results |
| aPeriods | Integer vector of periods to run. Default is all periods defined for the scenario type. | |||
| aVerbose | If TRUE, output additional debugging information. | |||
| run_ensemble | Generates a suite of different scenarios and calculates land use and land cover for each (by calling run_model) | N | Number of parameter sets to select | List of ScenarioInfo objects for the ensemble members |
| aOutputDir | Directory where outputs are saved | |||
| skip | Number of iterations to skip (i.e., if building on another run.) | |||
| atype | Scenario type: either “Reference” or “Hindcast” | |||
| logparallel | Name of directory to use for parallel workers’ log files. If NULL, then don’t write log files. | |||
| export_results | Saves results from a specified scenario as a csv file | aScenarioInfo | Scenario-related information, including names, logits, expectations. | csv file with model results |
| plotLandAllocation | Plots allocation over time by land type, with subregional detail | aScenarioInfo | Scenario-related information, including names, logits, expectations. | ggplot plot |
| plotRegionalLand Allocation | Plots allocation over time by land type, aggregated to region (as in Figure 2) | aScenarioInfo | Scenario-related information, including names, logits, expectations. | ggplot plot |
| ScenarioInfo | Creates a scenario information object that can be used in the functions above | aExpectationType | String indicating whether to use “Perfect”, “Lagged”, or “Linear” expectations | ScenarioInfo object |
| aLaggedShareOld | Weight to put on older information if “Lagged” expectations are used | |||
| aLinearYears | Number of years to use in extrapolation if “Linear” expectations are used | |||
| aLogitUseDefault | Boolean indicating whether to use default logits | |||
| aLogitAgroForest | AgroForest logit exponent (assuming mLogitUseDefault == FALSE) | |||
| aLogitAgroForest_NonPasture | AgroForest_NonPasture logit exponent (assuming mLogitUseDefault == FALSE) | |||
| aLogitCropland | Cropland logit exponent (assuming mLogitUseDefault == FALSE) | |||
| aScenarioType | Type of scenario to run: either “Reference” or “Hindcast” | |||
| aScenarioName | Complete scenario name, with expectations and logit information | |||
| aFileName | File name | |||
| aOutputDir | Output directory | |||
| aSerialNum | Serial number for a run that is part of a series. | |||
| aRegion | Region to use in the calculation. Right now we only run a single region at a time. | |||
