Skip to contents

Get annual summary data in a state.

Source: R/annual_summary_service.R
get_annual_summary_in_state.Rd

Get annual summary data in a state.

Usage

get_annual_summary_in_state(
  bdate,
  edate,
  state.fips,
  param,
  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.

state.fips

State FIPS code. Use get_state_fips() if unsure.

param

Pollutant parameter that site is measuring.

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 annual summary data for a state.

Examples

if (FALSE) { # \dontrun{
bdate <- "20200101"
edate <- "20200102"
state.fips <- "37"
param <- "42401"
result <- get_annual_summary_in_state(bdate,
                                      edate,
                                      state.fips,
                                      param)
result$Data
} # }