R/gcamrpt.R

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

#' Convert GCAM output to the format used by public IAM databases
#'
#' Provide functions for converting GCAM output into the format used by most IAM
#' experiments to enter results into their databases. Users provide a table of
#' desired outputs, along with options (such as filtering and aggregation), and
#' the package runs the necessary GCAM queries (no more than once per query) and
#' passes the results to the functions that produce the output.
#'
#' @section Usage:
#'
#' There are two main user-visible functions in the \code{gcamrpt} package.  The
#' first is the \code{\link{listVariables}} function.  This function returns a
#' list of the variables the system knows how to produce, which can be helpful
#' in putting together your control files.
#'
#' The main entry point into the report generator is the \code{\link{generate}}
#' function.  The generate function takes the names of two control files and a
#' string giving the location of your GCAM output databases.  There are also a
#' variety of options that determine how the output is formatted.  These options
#' and the the control file format are described in more detail in the
#' documentation to \code{\link{generate}}.
#'
#' @examples
#' \dontrun{
#' generate('my-scenarios.ctl', 'my-vars.ctl', '~/wrk/data/gcam-dbfiles',
#'          fileformat='CSV')
#' }
"_PACKAGE"