You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41 lines
1.4 KiB
41 lines
1.4 KiB
7 years ago
|
% Generated by roxygen2: do not edit by hand
|
||
|
|
% Please edit documentation in R/get-state-data.r
|
||
|
|
\name{get_state_data}
|
||
|
|
\alias{get_state_data}
|
||
|
|
\title{Retrieves state/territory-level influenza statistics from the CDC (deprecated)}
|
||
|
|
\usage{
|
||
|
|
get_state_data(years = as.numeric(format(Sys.Date(), "\%Y")))
|
||
|
|
}
|
||
|
|
\arguments{
|
||
|
|
\item{years}{a vector of years to retrieve data for (i.e. \code{2014} for CDC
|
||
|
|
flu season 2014-2015). Default value is the current year and all
|
||
|
|
\code{years} values should be >= \code{2008}}
|
||
|
|
}
|
||
|
|
\value{
|
||
|
|
A \code{data.frame} of state-level data for the specified seasons
|
||
|
|
(also classed as \code{cdcstatedata})
|
||
|
|
}
|
||
|
|
\description{
|
||
|
|
Uses the data source from the CDC' State-levelFluView
|
||
|
|
\url{https://gis.cdc.gov/grasp/fluview/main.html} and provides state flu
|
||
|
|
reporting data as a single data frame.\cr
|
||
|
|
\cr
|
||
|
|
This function provides similar data to \code{\link{get_weekly_flu_report}} but
|
||
|
|
provides more metadata about the reporting sources and has access to more
|
||
|
|
historical infomation.
|
||
|
|
}
|
||
|
|
\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 \code{httr::with_verbose}
|
||
|
|
if you would like to see what's going on.
|
||
|
|
}
|
||
|
|
\examples{
|
||
|
|
get_state_data(2014)
|
||
|
|
\dontrun{
|
||
|
|
get_state_data(c(2013, 2014))
|
||
|
|
get_state_data(2010:2014)
|
||
|
|
httr::with_verbose(get_state_data(2009:2015))
|
||
|
|
}
|
||
|
|
}
|