Skip to content

Commit

Permalink
clarifies the get_nhsn_weekly retrieval docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vpnagraj committed Dec 26, 2024
1 parent 2308329 commit ecd70a7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions R/retrieve.R
Original file line number Diff line number Diff line change
Expand Up @@ -913,12 +913,12 @@ who_nrevss <- function(region = c("national", "hhs", "census", "state"), years =
#'
#' This function retrieves weekly aggregated NHSN hospital respiratory data API. The function was written to use the default API endpoint (see description of "endpoint" argument and link in references). Note one the available endpoints includes data flagged as "preliminary". All reported weekly aggregates include the number of facilities reporting. In the weeks between April 28, 2024 and November 02, 2024 the NHSN flu hospitalization signal was not required to be reported.
#'
#' @param endpoint URL to data.cdc.gov endpoint; default is `"https://data.cdc.gov/api/views/mpgq-jmmr/rows.csv"`
#' @param endpoint URL to data.cdc.gov endpoint; default is `"https://data.cdc.gov/api/views/mpgq-jmmr/rows.csv"` for the preliminary reporting signal
#'
#' @return A `tibble` with the following columns:
#'
#' - **abbreviation**: Abbreviation of the state or US aggregate
#' - **week_end**: End date for the epiweek/epiyear being reproted
#' - **week_end**: End date for the epiweek/epiyear being reported
#' - **flu.admits**: Count of incident flu cases among hospitalized patients
#' - **flu.admits.cov**: Coverage (number of hospitals reporting) for incident flu cases
#' - **flu.admits.cov.perc**: Coverage (percentage of hospitals reporting) for incident flu cases
Expand Down
4 changes: 2 additions & 2 deletions man/get_nhsn_weekly.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ecd70a7

Please sign in to comment.