aqs_sites_by_county: aqs_sites_by_county

Description Usage Arguments Value Examples

View source: R/RAQSAPIlistfunctions.R

Description

\lifecycle

stable Returns data containing a table of all air monitoring sites with the input state and county FIPS code combination.

Usage

1
aqs_sites_by_county(stateFIPS, countycode, return_header = FALSE)

Arguments

stateFIPS

a R character object which represents the 2 digit state FIPS code (with leading zero) for the state being requested. @seealso aqs_states() for the list of available FIPS codes.

countycode

a R character object which represents the 3 digit state FIPS code for the county being requested (with leading zero(s)). @seealso aqs_counties_by_state() for the list of available county codes for each state.

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 all air monitoring sites with the requested state and county FIPS codes.

Examples

1
2
3
4
5
6
#returns an AQS_Data Mart_APIv2 S3 object witch returns all sites
          #  in Hawaii County, HI
          ## Not run: aqs_sites_by_county(stateFIPS = "15",
                                           countycode = "001")
                 
## End(Not run)

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