dropQueries: Drop specified queries from scenarios.

dropQueriesR Documentation

Drop specified queries from scenarios.

Description

This function removes the specified queries from a data set. By default the queries are removed from every scenario they appear in, but the operation can be limited to certain scenarios if desired. If the operation is performed on a file, the file is also modified. If it is performed on a data set that has already been loaded, then the change is written back to the file only if writeback is set to TRUE. Either way, the modified data set is returned.

Usage

dropQueries(
  proj,
  queries,
  invert = FALSE,
  writeback = is.character(proj),
  scenarios = NULL,
  invertScenario = FALSE
)

Arguments

proj

Project data or data file name.

queries

Name(s) of the queries to drop.

invert

If TRUE then delete all queries except the ones in queries.

writeback

If TRUE then write the change to the backing data file.

scenarios

Drop the queries only from the specified scenarios (default is to drop from all scenarios).

invertScenario

Drop queries from the scenarios not listed in scenarios.

Details

As with dropScenarios, it is possible and perhaps occasionally useful to specify a file but to force the file not to be updated by specifying writeback=FALSE.


JGCRI/rgcam documentation built on July 2, 2022, 10:20 a.m.