aqs_sampledurations: aqs_sampledurations

View source: R/RAQSAPIlistfunctions.R

aqs_sampledurationsR Documentation

aqs_sampledurations

Description

\lifecycle

stable Returns a table of sample durations and their associated duration codes. Returned values are not calculated durations such as 8 hour CO or O$_3$ rolling averages, 3/6 day PM averages or Pb 3 month rolling averages.

Usage

aqs_sampledurations(return_header = FALSE)

Arguments

return_header

If FALSE (default) only returns data requested. If TRUE returns a AQSAPI_v2 object which is a two item list that contains header information returned from the API server mostly used for debugging purposes in addition to the data requested.

Value

a tibble or an AQS_Data Mart_APIv2 S3 object of sample durations and their associated duration codes (groups of parameters, i.e. "criteria" or "all").

Note

Not all sample durations that are available through AQS are available through the AQS Data Mart API, including certain calculated sample durations. Only sample durations that are available through the AQS Data Mart API are returned.

Examples

# Returns a tibble or an AQS_Data Mart_APIv2 S3 object of
         ## Not run:  aqs_sampledurations() 

USEPA/RAQSAPI documentation built on Jan. 18, 2024, 1:50 a.m.