Merge branch 'use-delphidocs' of https://github.com/cmu-delphi/epidatr into use-delphidocs

Author: dajmcdon

CRAN-SUBMISSION

@@ -1,3 +1,3 @@
-Version: 1.1.1
-Date: 2024-03-02 01:36:14 UTC
-SHA: 75ae42aed7a035d184af69129e049c31e76e5f3b
+Version: 1.2.0
+Date: 2024-06-20 18:52:31 UTC
+SHA: 9a79a8bcb534ccd915a1189294cd6131053bc666

R/endpoints.R

@@ -163,8 +163,8 @@ pub_covid_hosp_facility_lookup <- function(
 #' )
 #'
 #' pub_covid_hosp_facility(
-#'   hospital_pks = "100075",
-#'   collection_weeks = epirange(202001, 202005)
+#'   hospital_pks = "050063",
+#'   collection_weeks = epirange(20240101, 20240301)
 #' )
 #' }
 #' @param hospital_pks character. Facility identifiers.
@@ -1848,7 +1848,7 @@ pub_nidss_flu <- function(
 #' \dontrun{
 #' pvt_norostat(
 #'   auth = Sys.getenv("SECRET_API_AUTH_NOROSTAT"),
-#'   locations = "1",
+#'   locations = "Minnesota, Ohio, Oregon, Tennessee, and Wisconsin",
 #'   epiweeks = 201233
 #' )
 #' }

man/pub_covid_hosp_facility.Rd

@@ -117,7 +117,9 @@ pub_covidcast(
 )
 ```
 
-We can fetch a subset of states by listing out the desired locations:
+Alternatively, we can fetch the full time series for a subset of states by 
+listing out the desired locations in the `geo_value` argument and using `*`
+in the `time_values` argument:
 
 ```{r, eval = FALSE}
 # Obtain the most up-to-date version of the smoothed covid-like illness (CLI)
@@ -128,24 +130,8 @@ pub_covidcast(
   geo_type = "state",
   time_type = "day",
   geo_values = c("pa", "ca", "fl"),
-  time_values = epirange(20210105, 20210410)
-)
-```
-
-We can also request data for a single location at a time, via the `geo_values` argument.
-
-```{r}
-# Obtain the most up-to-date version of the smoothed covid-like illness (CLI)
-# signal from the COVID-19 Trends and Impact survey for Pennsylvania
-epidata <- pub_covidcast(
-  source = "fb-survey",
-  signals = "smoothed_cli",
-  geo_type = "state",
-  time_type = "day",
-  geo_values = "pa",
-  time_values = epirange(20210105, 20210410)
+  time_values = "*"
 )
-knitr::kable(head(epidata))
 ```
 
 ## Getting versioned data