get_state_data: Retrieves state/territory-level influenza statistics from the...

View source: R/get-state-data.r

get_state_dataR Documentation

Retrieves state/territory-level influenza statistics from the CDC (deprecated)

Description

Uses the data source from the CDC' State-levelFluView https://gis.cdc.gov/grasp/fluview/main.html and provides state flu reporting data as a single data frame.

This function provides similar data to get_weekly_flu_report but provides more metadata about the reporting sources and has access to more historical infomation.

Usage

get_state_data(years = as.numeric(format(Sys.Date(), "%Y")))

Arguments

years

a vector of years to retrieve data for (i.e. 2014 for CDC flu season 2014-2015). Default value is the current year and all years values should be >= 2008

Value

A data.frame of state-level data for the specified seasons (also classed as cdcstatedata)

Note

There is often a noticeable delay when making the API request to the CDC. This is not due to a large download size, but the time it takes for their servers to crunch the data. Wrap the function call in httr::with_verbose if you would like to see what's going on.

Examples

state_data <- get_state_data(2014)
## Not run: 
gsd <- get_state_data(c(2013, 2014))
gsd <- get_state_data(2010:2014)

## End(Not run)

hrbrmstr/cdcfluview documentation built on Nov. 25, 2022, 7:55 p.m.