Skip to content

Commit 6e9f899

Browse files
authored
Merge pull request #231 from cmu-delphi/ndefries/straggling-endpt-refs
Fix endpoint references missing `pub_`, `pvt_` prefixes
2 parents 028ff8c + c7e95f6 commit 6e9f899

File tree

9 files changed

+25
-22
lines changed

9 files changed

+25
-22
lines changed

R/cache.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ cache_environ$epidatr_cache <- NULL
3434
#' specify either `issues` before a certain date, or `as_of` before a certain
3535
#' date will actually cache. For example the call
3636
#' ```
37-
#' covidcast(
37+
#' pub_covidcast(
3838
#' source = "jhu-csse",
3939
#' signals = "confirmed_7dav_incidence_prop",
4040
#' geo_type = "state",
@@ -46,7 +46,7 @@ cache_environ$epidatr_cache <- NULL
4646
#' *won't* cache, since it is possible for the cache to be invalidated by new
4747
#' releases with no warning. On the other hand, the call
4848
#' ```
49-
#' covidcast(
49+
#' pub_covidcast(
5050
#' source = "jhu-csse",
5151
#' signals = "confirmed_7dav_incidence_prop",
5252
#' geo_type = "state",

R/endpoints.R

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1320,7 +1320,7 @@ pub_fluview_clinical <- function(regions, epiweeks, ..., issues = NULL, lag = NU
13201320
#' Metadata for the FluView endpoint
13211321
#' @description
13221322
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/fluview_meta.html>
1323-
#' Returns information about the fluview endpoint.
1323+
#'
13241324
#' @examples
13251325
#' \dontrun{
13261326
#' pub_fluview_meta()
@@ -1712,8 +1712,8 @@ pub_nidss_flu <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fet
17121712
#'
17131713
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/norostat.html>
17141714
#'
1715-
#' This is the documentation of the API for accessing the NoroSTAT (norostat)
1716-
#' endpoint of the Delphi’s epidemiological data.
1715+
#' This is the documentation of the API for accessing the NoroSTAT endpoint of
1716+
#' the Delphi’s epidemiological data.
17171717
#'
17181718
#' @examples
17191719
#' \dontrun{
@@ -1887,7 +1887,7 @@ pvt_quidel <- function(auth, locations, epiweeks, fetch_args = fetch_args_list()
18871887
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/sensors.html>
18881888
#'
18891889
#' This is the documentation of the API for accessing the Digital Surveillance
1890-
#' Sensors (sensors) endpoint of the Delphi’s epidemiological Note: this
1890+
#' Sensors endpoint of the Delphi’s epidemiological. Note: this
18911891
#' repository was built to support modeling and forecasting efforts
18921892
#' surrounding seasonal influenza (and dengue). In the current COVID-19
18931893
#' pandemic, syndromic surveillance data, like ILI data (influenza-like
@@ -1942,8 +1942,9 @@ pvt_sensors <- function(auth, names, locations, epiweeks, fetch_args = fetch_arg
19421942
#' @description
19431943
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/twitter.html>
19441944
#'
1945-
#' This is the API documentation for accessing the Twitter Stream (twitter) endpoint of Delphi’s epidemiological data.
1946-
#' Sourced from [Healthtweets](http://www.healthtweets.org/)
1945+
#' This is the API documentation for accessing the Twitter Stream endpoint of
1946+
#' Delphi’s epidemiological data. Sourced from
1947+
#' [Healthtweets](http://www.healthtweets.org/)
19471948
#'
19481949
#' @examples
19491950
#' \dontrun{

R/epidatacall.R

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,10 @@ fetch_args_list <- function(
201201
#' Fetches the data
202202
#'
203203
#' @details
204-
#' `fetch` usually returns the data in tibble format, but a few of the endpoints
205-
#' only support the JSON classic format (delphi, pvt_meta_norostat, and meta).
206-
#' In that case a JSON-like nested list structure is returned instead.
204+
#' `fetch` usually returns the data in tibble format, but a few of the
205+
#' endpoints only support the JSON classic format (`pub_delphi`,
206+
#' `pvt_meta_norostat`, and `pub_meta`). In that case a
207+
#' JSON-like nested list structure is returned instead.
207208
#'
208209
#' @rdname epidata_call
209210
#' @param epidata_call an instance of `epidata_call`

man/epidata_call.Rd

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

man/pub_fluview_meta.Rd

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

man/pvt_norostat.Rd

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

man/pvt_sensors.Rd

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

man/pvt_twitter.Rd

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

man/set_cache.Rd

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

0 commit comments

Comments
 (0)