aqs_classes: aqs_classes

Description Usage Arguments Value Examples

View source: R/RAQSAPIlistfunctions.R

Description

\lifecycle

stable Returns a table of Parameter classes (groups of parameters, i.e. "criteria" or "all"). The information from this function can be used as input to other API calls.

Usage

1
aqs_classes(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 Parameter classes (groups of parameters, i.e. "criteria" or "all").

Examples

1
2
3
4
#returns a tibble or an AQS_Data Mart_APIv2 S3 object of
          #  parameter classes (groups of parameters, i.e. "criteria" or
          #  all")
         ## Not run:  aqs_classes() 

RAQSAPI documentation built on Jan. 29, 2022, 1:08 a.m.