listScenariosInDB: Lists the Scenarios contained in a GCAM Database

In JGCRI/rgcam: Tools for importing and working with GCAM results

Lists the Scenarios contained in a GCAM Database

Description

To run a query users typically need to know the names of the scenarios in the database. If they are the ones to generate the data in the first place they may already know this information. Otherwise they could use this method to find out. The result of this call will be a table with columns name, date, version, and fqName. The name and date are exactly as specified in the datbase. The fqName is the fully qualified scenario name which a user could use in the scenarios argument of runQuery if they need to disambiguate scenario names. We also include the GCAM version tag that was used to generate the scenario in the format: ver_<major>.<minor>_r<git describe value>.

Usage

listScenariosInDB(dbConn)

## S3 method for class 'localDBConn'
listScenariosInDB(dbConn)

## S3 method for class 'remoteDBConn'
listScenariosInDB(dbConn)

Arguments

dbConn

The connection to a database which will handle listing the scenarios.

Value

A table with columns name, date, version, and fqName and rows for each scenario in the database.

Methods (by class)

• localDBConn: List scenarios in a local GCAM database

• remoteDBConn: List scenarios in a remote database

JGCRI/rgcam documentation built on June 7, 2024, 10:54 a.m.