runModule: Run a data module

In JGCRI/iamrpt: Convert GCAM results to the format required by various IAM experiment databases

Description

Run the module associated with object var. If mode is GETQ, return a character vector of the names of all GCAM queries needed as input by the module. If mode is RUN, return a data frame containing the processed variable.

Usage

runModule(var, mode, allqueries = NULL, aggkeys = NULL, aggfn = NULL,
  years = NULL, filters = NULL, ounit = NULL)

Arguments

var	Name of the variable to produce. This must be one of the varibles known to the system. The listVariables function lists the known variables.
mode	Either GETQ or RUN. The former returns the names of the GCAM queries needed for the calculation; the latter runs the calculation. In GETQ mode all of the remaining arguments are ignored.
allqueries	List of all the queries pulled by the system.
aggkeys	Character string listing the aggregation columns desired. All of these columns must be present in the table computed by the main body of the function. If empty or NULL, no aggregation will be performed.
aggfn	Function to use for aggregating. If none specified, sum will be used.
years	Years to include in the output
filters	Character string giving a list of additional filters to be applied, in s-exp format.
ounit	Desired output unit. If omitted, results will be returned with no unit conversion.

JGCRI/iamrpt documentation built on June 30, 2019, 3:19 a.m.