Skip to content

Commit b5acce7

Browse files
committed
docs: correcting regions' description for pub_fluview functions
1 parent 0b744e6 commit b5acce7

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

R/endpoints.R

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1368,9 +1368,12 @@ pub_flusurv <- function(
13681368
#' pub_fluview_clinical(regions = "nat", epiweeks = epirange(201601, 201701))
13691369
#'
13701370
#' @inheritParams .epidatr_shared_params
1371-
#' @param regions character. Locations to fetch. Can be any string IDs in
1372-
#' national, HHS region, census division, most states and territories, and so
1373-
#' on. Full list link below.
1371+
#' @param regions character. Vector of location IDs to fetch. Can be
1372+
#' "nat" for national, "hhs1"--"hhs10" for HHS Regions, "cen1"--"cen9" for
1373+
#' census divisions, lowercase two-letter state or territory abbreviations
1374+
#' for most states and territories,"jfk" for New York City, or "ny_minus_jfk"
1375+
#' for upstate New York. Full list of locations is available
1376+
#' [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt).
13741377
#' @return [`tibble::tibble`]
13751378
#'
13761379
#' @inheritSection .epidatr_shared_params Data Versioning
@@ -1468,8 +1471,8 @@ pub_fluview_meta <- function(fetch_args = fetch_args_list()) {
14681471
#'
14691472
#' pub_fluview(regions = "nat", epiweeks = epirange(201201, 202005))
14701473
#'
1471-
#' @inheritParams .epidatr_shared_params
14721474
#' @inheritParams pub_fluview_clinical
1475+
#' @inheritParams .epidatr_shared_params
14731476
#' @return [`tibble::tibble`]
14741477
#'
14751478
#' @inheritSection .epidatr_shared_params Data Versioning

man/pub_fluview.Rd

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/pub_fluview_clinical.Rd

Lines changed: 6 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)