aqs_isavailable: aqs_isavailable

Description Usage Arguments Value list functions Examples

View source: R/RAQSAPIlistfunctions.R

Description

\lifecycle

stable returns a tibble or an AQS_Data Mart_APIv2 S3 object explaining the status of the AQS API.

Usage

1
aqs_isavailable(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 which details the status of the AQS API (The status information is located in the header)

list functions

NA

Examples

1
2
  #check if the AQS API is up, running and accepting requests.
  ## Not run:  aqs_isAvailable() 

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