From 675762f595931dd3345f5c18a09ac4a89033d40f Mon Sep 17 00:00:00 2001 From: Nate McIntosh Date: Fri, 25 Oct 2024 08:53:25 -0400 Subject: [PATCH] Mention us is option (#91) * added US as an option * run document * forgot to update NEWS --- NEWS.md | 1 + R/read_data.R | 2 +- man/read_data.Rd | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/NEWS.md b/NEWS.md index 16935705..88ff7967 100644 --- a/NEWS.md +++ b/NEWS.md @@ -30,3 +30,4 @@ * Read from new parameters schema * Fix bugs in parameter reading from local test run * Fix bugs in parameter reading from local test run +* Add "US" as an option in `state_abb` diff --git a/R/read_data.R b/R/read_data.R index 62e89b5d..d36ca104 100644 --- a/R/read_data.R +++ b/R/read_data.R @@ -18,7 +18,7 @@ #' @param data_path The path to the local file. This could contain a glob and #' must be in parquet format. #' @param disease One of "COVID-19" or "Influenza" -#' @param state_abb A two-letter uppercase abbreviation +#' @param state_abb A two-letter uppercase abbreviation. "US" is also an option #' @param report_date The desired single report date #' @param max_reference_date,min_reference_date The first and last reference #' dates, inclusive, of the timeseries diff --git a/man/read_data.Rd b/man/read_data.Rd index 87fcdfdc..400ba4ad 100644 --- a/man/read_data.Rd +++ b/man/read_data.Rd @@ -19,7 +19,7 @@ must be in parquet format.} \item{disease}{One of "COVID-19" or "Influenza"} -\item{state_abb}{A two-letter uppercase abbreviation} +\item{state_abb}{A two-letter uppercase abbreviation. "US" is also an option} \item{report_date}{The desired single report date}