diff --git a/R/data.R b/R/data.R index afcc398..cca78b2 100644 --- a/R/data.R +++ b/R/data.R @@ -4,7 +4,7 @@ #' US census reference table with the addition of "US" for the #' United States as a whole. #' -#' @format ## `us_location_table` +#' @format #' A tibble with 58 rows and 3 columns: #' \describe{ #' \item{location_code}{2-character location code} @@ -13,3 +13,21 @@ #' } #' @source , us_location_table.R "us_location_table" + +#' An example daily-resolution set of forecast trajectories for influenza. +#' +#' 53 US states and territories are represented, coded according to their +#' USPS two-letter abbreviations: the 50 US states, Puerto Rico, +#' the District of Columbia, and the US Virgin Islands. 100 randomly +#' chosen draws from an original MCMC sample of 4000 are provided +#' +#' @format +#' A tibble with 159,000 rows and 4 columns: +#' \describe{ +#' \item{.draw}{Unique identifier for an individual MCMC draw.} +#' \item{date}{Date for a forecasted count.} +#' \item{hosp}{Forecasted count of hospital admissions.} +#' \item{location}{Location for a forecasted count.} +#' } +#' @source data-raw/example_daily_forecast_flu.R +"example_daily_forecast_flu" diff --git a/man/example_daily_forecast_flu.Rd b/man/example_daily_forecast_flu.Rd new file mode 100644 index 0000000..f4153a0 --- /dev/null +++ b/man/example_daily_forecast_flu.Rd @@ -0,0 +1,28 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/data.R +\docType{data} +\name{example_daily_forecast_flu} +\alias{example_daily_forecast_flu} +\title{An example daily-resolution set of forecast trajectories for influenza.} +\format{ +A tibble with 159,000 rows and 4 columns: +\describe{ +\item{.draw}{Unique identifier for an individual MCMC draw.} +\item{date}{Date for a forecasted count.} +\item{hosp}{Forecasted count of hospital admissions.} +\item{location}{Location for a forecasted count.} +} +} +\source{ +data-raw/example_daily_forecast_flu.R +} +\usage{ +example_daily_forecast_flu +} +\description{ +53 US states and territories are represented, coded according to their +USPS two-letter abbreviations: the 50 US states, Puerto Rico, +the District of Columbia, and the US Virgin Islands. 100 randomly +chosen draws from an original MCMC sample of 4000 are provided +} +\keyword{datasets} diff --git a/man/us_location_table.Rd b/man/us_location_table.Rd index 4805b6d..2ab8f88 100644 --- a/man/us_location_table.Rd +++ b/man/us_location_table.Rd @@ -5,8 +5,6 @@ \alias{us_location_table} \title{Table of US location names and codes} \format{ -\subsection{\code{us_location_table}}{ - A tibble with 58 rows and 3 columns: \describe{ \item{location_code}{2-character location code} @@ -14,7 +12,6 @@ A tibble with 58 rows and 3 columns: \item{long_name}{Full name of the location} } } -} \source{ \url{https://www2.census.gov/geo/docs/reference/state.txt}, us_location_table.R }