diff --git a/R/retrieve.R b/R/retrieve.R index 8ce4446..4e029db 100644 --- a/R/retrieve.R +++ b/R/retrieve.R @@ -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 diff --git a/man/get_nhsn_weekly.Rd b/man/get_nhsn_weekly.Rd index 8219c0a..c9dff79 100644 --- a/man/get_nhsn_weekly.Rd +++ b/man/get_nhsn_weekly.Rd @@ -7,13 +7,13 @@ get_nhsn_weekly(endpoint = "https://data.cdc.gov/api/views/mpgq-jmmr/rows.csv") } \arguments{ -\item{endpoint}{URL to data.cdc.gov endpoint; default is \code{"https://data.cdc.gov/api/views/mpgq-jmmr/rows.csv"}} +\item{endpoint}{URL to data.cdc.gov endpoint; default is \code{"https://data.cdc.gov/api/views/mpgq-jmmr/rows.csv"} for the preliminary reporting signal} } \value{ A \code{tibble} with the following columns: \itemize{ \item \strong{abbreviation}: Abbreviation of the state or US aggregate -\item \strong{week_end}: End date for the epiweek/epiyear being reproted +\item \strong{week_end}: End date for the epiweek/epiyear being reported \item \strong{flu.admits}: Count of incident flu cases among hospitalized patients \item \strong{flu.admits.cov}: Coverage (number of hospitals reporting) for incident flu cases \item \strong{flu.admits.cov.perc}: Coverage (percentage of hospitals reporting) for incident flu cases