pub_flusurv: CDC FluSurv flu hospitalizations

View source: R/endpoints.R

pub_flusurvR Documentation

CDC FluSurv flu hospitalizations

Description

API docs: https://cmu-delphi.github.io/delphi-epidata/api/flusurv.html.

Obtain information on influenza hospitalization rates from the Center of Disease Control.

See also https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html.

Usage

pub_flusurv(
  locations,
  epiweeks = "*",
  ...,
  issues = NULL,
  lag = NULL,
  fetch_args = fetch_args_list()
)

Arguments

locations

character. Character vector indicating location.

epiweeks

timeset. Epiweeks to fetch. Defaults to all ("*") dates.

...

not used for values, forces later arguments to bind by name

issues

timeset. Optionally, the issues to fetch. If not set, the most recent issue is returned. Mutually exclusive with lag.

lag

integer. Optionally, the lag of the issues to fetch. If not set, the most recent issue is returned. Mutually exclusive with issues.

fetch_args

fetch_args. Additional arguments to pass to fetch().

Details

The list of location argument can be found in https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/flusurv_locations.txt.

Value

tibble::tibble

Examples

## Not run: 
pub_flusurv(locations = "CA", epiweeks = epirange(201701, 201801))

## End(Not run)

epidatr documentation built on June 22, 2024, 9:15 a.m.