aqs_cbsas: aqs_cbsas

Description Usage Arguments Value Examples

View source: R/RAQSAPIlistfunctions.R

Description

\lifecycle

stable Returns a table of all Core Based Statistical Areas (cbsa) and their associated cbsa_codes. for constructing other requests.

Usage

1
aqs_cbsas(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 all Core Based Statistical Areas (cbsa) and their cbsa_codes for constructing other requests.

Examples

1
2
3
#returns a tibble or an AQS_Data Mart_APIv2 S3 object of cbsas
          #  and their respective cbsa codes
          ## Not run:  aqs_cbsas() 

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