Skip to content

Commit 76769a8

Browse files
committed
updating endpoints inputs
1 parent 6ff37d3 commit 76769a8

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

R/endpoints.R

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#' \dontrun{
77
#' pvt_cdc(
88
#' auth = "yourkey",
9-
#' "fl,ca",
9+
#' locations = "fl,ca",
1010
#' epirange(201501, 201601)
1111
#' ) %>% fetch()
1212
#' }
@@ -62,6 +62,7 @@ pvt_cdc <- function(auth, locations, epiweeks) {
6262
#' @examples
6363
#' \donttest{
6464
#' covid_hosp_facility_lookup(state = "fl") %>% fetch()
65+
#' covid_hosp_facility_lookup(city = "southlake") %>% fetch()
6566
#' }
6667
#' @param state string. A two-letter character string state abbreviation.
6768
#' @param ccn string. A character string for facility CMS certification number.
@@ -778,7 +779,7 @@ delphi <- function(system, epiweek) {
778779
#' @examples
779780
#' \dontrun{
780781
#' dengue_nowcast(
781-
#' locations = "?",
782+
#' locations = "pr",
782783
#' epiweeks = epirange(201501, 202001)
783784
#' ) %>% fetch()
784785
#' }
@@ -814,8 +815,8 @@ dengue_nowcast <- function(locations, epiweeks) {
814815
#' \dontrun{
815816
#' pvt_dengue_sensors(
816817
#' auth = "yourkey",
817-
#' names = "?",
818-
#' locations = "?",
818+
#' names = "ght",
819+
#' locations = "ag",
819820
#' epiweeks = epirange(201501, 202001)
820821
#' ) %>% fetch()
821822
#' }
@@ -1019,6 +1020,10 @@ fluview_clinical <- function(regions, epiweeks, issues = NULL, lag = NULL) {
10191020
#' Fetch FluView metadata
10201021
#'
10211022
#' API docs: https://cmu-delphi.github.io/delphi-epidata/api/fluview_meta.html
1023+
#' @examples
1024+
#' \donttest{
1025+
#' fluview_meta() %>% fetch()
1026+
#' }
10221027
#'
10231028
#' @return [`epidata_call`]
10241029
#'
@@ -1158,7 +1163,7 @@ gft <- function(locations, epiweeks) {
11581163
#' auth = "yourkey",
11591164
#' locations = "ca",
11601165
#' epiweeks = epirange(201201, 202001),
1161-
#' query = "?"
1166+
#' query = "how to get over the flu"
11621167
#' ) %>% fetch()
11631168
#' }
11641169
#' @param auth string. Restricted access key (not the same as API key).
@@ -1198,7 +1203,7 @@ pvt_ght <- function(auth, locations, epiweeks, query) {
11981203
#' TODO: find a non-trivial region
11991204
#' @examples
12001205
#' \dontrun{
1201-
#' kcdc_ili(regions = "?", epiweeks = epirange(201201, 202001)) %>% fetch()
1206+
#' kcdc_ili(regions = "ROC", epiweeks = 200436) %>% fetch()
12021207
#' }
12031208
#' @param regions character vector. The regions to be fetched.
12041209
#' @param epiweeks [`timeset`]. The epiweeks to be fetched.
@@ -1243,6 +1248,10 @@ kcdc_ili <- function(regions, epiweeks, issues = NULL, lag = NULL) {
12431248
#'
12441249
#' API docs: https://cmu-delphi.github.io/delphi-epidata/api/meta_norostat.html
12451250
#'
1251+
#' @examples
1252+
#' \donttest{
1253+
#' pvt_meta_norostat(auth = "yourkey") %>% fetch()
1254+
#' }
12461255
#' @param auth string. Restricted access key (not the same as API key).
12471256
#' @return [`epidata_call`]
12481257
#'
@@ -1363,8 +1372,8 @@ nidss_flu <- function(regions, epiweeks, issues = NULL, lag = NULL) {
13631372
#' \dontrun{
13641373
#' pvt_norostat(
13651374
#' auth = "yourkey",
1366-
#' locations = "Minnesota, Ohio, Oregon, Tennessee, and Wisconsin",
1367-
#' epiweeks = epirange(201401, 201501)
1375+
#' locations = "1",
1376+
#' epiweeks = 201233
13681377
#' ) %>% fetch()
13691378
#' }
13701379
#' @param auth string. Your authentication key.

0 commit comments

Comments
 (0)