parse_batch_query: Parse a Model Interface batch query file

View source: R/importgcam.R

parse_batch_queryR Documentation

Parse a Model Interface batch query file

Description

Given a Model Interface batch query file (i.e., an XML file detailing queries that the user might wish to run), parse the file to produce a list of queries that can be run by runQuery.

Usage

parse_batch_query(fn)

Arguments

fn

Name of the batch query file to parse

Details

The queries parsed from the batch query file are returned as a list of query information struatures. Each structure q has elements q$regions (regions specified in the query), q$title (title of the query), and q$query (the XML specification of the query from the batch file). The query and regions items are suitable for passing to the corresponding arguments of runQuery. However, it is not required to use the regions argument; one can instead supply a different list of regions, or no list at all (implicitly running all regions), as described in the runQuery documentation.

Value

A list of query structures for the queries found in the batch file.


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