Skip to contents

Get annual summary data in a Core Based Statistical Area.

Source: R/annual_summary_service.R
get_annual_summary_in_cbsa.Rd

Get annual summary data in a Core Based Statistical Area.

Usage

get_annual_summary_in_cbsa(
  bdate,
  edate,
  param,
  cbsa,
  cached = TRUE,
  cache_directory = "/cache",
  cbdate = NULL,
  cedate = NULL
)

Arguments

bdate

Beginning date to check. Year, month, day format.

edate

Ending date to check. Year, month, day format.

param

Pollutant parameter that site is measuring.

cbsa

An encoding for a Core Base Statiscal Area. If unsure, use get_cbsas().

cached

TRUE or FALSE specifying if the data from the call is to be cached. Default: TRUE. (Optional)

cache_directory

Place inside user-level cache directory to store the cached data. Default: "/cache". (Optional)

cbdate

Beginning date of last change to DB. (Optional)

cedate

Ending date of last change to DB. (Optional)

Value

API response containing quarterly summary data at the cbsa level.

Examples

if (FALSE) { # \dontrun{
bdate <- "20190101"
edate <- "20190601"
cbsa <- "16740"
param <- "42401"
result <- get_annual_summary_in_cbsa(bdate, 
                                     edate, 
                                     param, 
                                     cbsa)
result$Data
} # }