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.

31 lines
1.1 KiB

  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/get-weekly-flu-report.r
  3. \name{get_weekly_flu_report}
  4. \alias{get_weekly_flu_report}
  5. \title{Retrieves (high-level) weekly (XML) influenza surveillance report from the CDC}
  6. \usage{
  7. get_weekly_flu_report()
  8. }
  9. \value{
  10. \code{tbl_df} (also classed with \code{cdcweeklyreport}) with six
  11. columns: \code{year}, \code{week_number}, \code{state}, \code{color},
  12. \code{label}, \code{subtitle}
  13. }
  14. \description{
  15. The CDC publishes a \href{https://www.cdc.gov/flu/weekly/usmap.htm}{weekly
  16. influenza report} detailing high-level flu activity per-state. They also
  17. publish a data file (see \code{References}) of historical report readings.
  18. This function reads that XML file and produces a long \code{data_frame}
  19. with the historical surveillance readings.\cr
  20. \cr
  21. This function provides similar data to \code{\link{get_state_data}} but without
  22. the reporting source metadata and a limit on the historical flu information.
  23. }
  24. \examples{
  25. \dontrun{
  26. wfr <- get_weekly_flu_report()
  27. }
  28. }
  29. \references{
  30. \url{https://www.cdc.gov/flu/weekly/flureport.xml}
  31. }