Influenza and dengue digital surveillance sensors

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

This is the documentation of the API for accessing the Digital Surveillance Sensors endpoint of the Delphi’s epidemiological. Note: this repository was built to support modeling and forecasting efforts surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic, syndromic surveillance data, like ILI data (influenza-like illness) through FluView, will likely prove very useful. However, we urge caution to users examining the digital surveillance sensors, like ILI Nearby, Google Flu Trends, etc., during the COVID-19 pandemic, because these were designed to track ILI as driven by seasonal influenza, and were NOT designed to track ILI during the COVID-19 pandemic.

Usage

pvt_sensors(
  auth,
  names,
  locations,
  epiweeks = "*",
  fetch_args = fetch_args_list()
)

Arguments

auth: string. Your restricted access key (not the same as API key).
names: character. List of sensor names to fetch. See the data sources available for details.
locations: character. List of locations to fetch. See the codes of the US regions and states # nolint for details.
epiweeks: timeset. Epiweeks to fetch. Supports epirange() and defaults to all ("*") dates. Format as epirange(startweek, endweek), where startweek and endweek are of the form YYYYWW (string or numeric).
fetch_args: fetch_args. Additional arguments to pass to fetch(). See fetch_args_list() for details.

Value

tibble::tibble

Examples

if (FALSE) { # \dontrun{
pvt_sensors(
  auth = Sys.getenv("DELPHI_EPIDATA_KEY"),
  names = "sar3",
  locations = "nat",
  epiweeks = epirange(201501, 202001)
)
} # }