query_available_results: View metabolism model results available on the StreamPULSE...

View source: R/query_available_results.R

query_available_resultsR Documentation

View metabolism model results available on the StreamPULSE server.

Description

Uses StreamPULSE API to query data. To download model results, see request_results.

Usage

query_available_results(region = NULL, site = NULL, year = NULL)

Arguments

region

string representing region. Must be a StreamPULSE region abbreviation like 'NC' or 'AZ', or 'all' for a list of all available model results.

site

string representing site. Must be a StreamPULSE site abbreviation like 'Eno' or 'LV'.

year

string or numeric representing year, e.g. '2015' or 2015.

Details

The data returned by this function depend on which of the input parameters are specified and which are omitted. See examples for all possible ways to use this function.

Value

returns a list containing a single data frame with region, site, and year columns.

Author(s)

Mike Vlah, vlahm13@gmail.com

See Also

request_results for downloading StreamPULSE model outputs.

Examples

View all available model results from region
query_available_results(region='NC')

View all available model results from all regions
query_available_results(region='all')

View all available model results from site
query_available_results(region='NC', site='Eno')

View all available model results from year
query_available_results(year=2017)

View all available model results from region and year
query_available_results(region='NC', year=2017)

streampulse/StreamPULSE documentation built on Nov. 2, 2024, 9:54 p.m.