Skip to content

Commit

Permalink
fix endpt refs missing pub_, pvt_ prefixes
Browse files Browse the repository at this point in the history
  • Loading branch information
nmdefries committed Dec 12, 2023
1 parent 028ff8c commit b1917e9
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 22 deletions.
4 changes: 2 additions & 2 deletions R/cache.R
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ cache_environ$epidatr_cache <- NULL
#' specify either `issues` before a certain date, or `as_of` before a certain
#' date will actually cache. For example the call
#' ```
#' covidcast(
#' pub_covidcast(
#' source = "jhu-csse",
#' signals = "confirmed_7dav_incidence_prop",
#' geo_type = "state",
Expand All @@ -46,7 +46,7 @@ cache_environ$epidatr_cache <- NULL
#' *won't* cache, since it is possible for the cache to be invalidated by new
#' releases with no warning. On the other hand, the call
#' ```
#' covidcast(
#' pub_covidcast(
#' source = "jhu-csse",
#' signals = "confirmed_7dav_incidence_prop",
#' geo_type = "state",
Expand Down
13 changes: 7 additions & 6 deletions R/endpoints.R
Original file line number Diff line number Diff line change
Expand Up @@ -1320,7 +1320,7 @@ pub_fluview_clinical <- function(regions, epiweeks, ..., issues = NULL, lag = NU
#' Metadata for the FluView endpoint
#' @description
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/fluview_meta.html>
#' Returns information about the fluview endpoint.
#'
#' @examples
#' \dontrun{
#' pub_fluview_meta()
Expand Down Expand Up @@ -1712,8 +1712,8 @@ pub_nidss_flu <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fet
#'
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/norostat.html>
#'
#' This is the documentation of the API for accessing the NoroSTAT (norostat)
#' endpoint of the Delphi’s epidemiological data.
#' This is the documentation of the API for accessing the NoroSTAT endpoint of
#' the Delphi’s epidemiological data.
#'
#' @examples
#' \dontrun{
Expand Down Expand Up @@ -1887,7 +1887,7 @@ pvt_quidel <- function(auth, locations, epiweeks, fetch_args = fetch_args_list()
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/sensors.html>
#'
#' This is the documentation of the API for accessing the Digital Surveillance
#' Sensors (sensors) endpoint of the Delphi’s epidemiological Note: this
#' Sensors endpoint of the Delphi’s epidemiological Note: this
#' repository was built to support modeling and forecasting efforts
#' surrounding seasonal influenza (and dengue). In the current COVID-19
#' pandemic, syndromic surveillance data, like ILI data (influenza-like
Expand Down Expand Up @@ -1942,8 +1942,9 @@ pvt_sensors <- function(auth, names, locations, epiweeks, fetch_args = fetch_arg
#' @description
#' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/twitter.html>
#'
#' This is the API documentation for accessing the Twitter Stream (twitter) endpoint of Delphi’s epidemiological data.
#' Sourced from [Healthtweets](http://www.healthtweets.org/)
#' This is the API documentation for accessing the Twitter Stream endpoint of
#' Delphi’s epidemiological data. Sourced from
#' [Healthtweets](http://www.healthtweets.org/)
#'
#' @examples
#' \dontrun{
Expand Down
7 changes: 4 additions & 3 deletions R/epidatacall.R
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,10 @@ fetch_args_list <- function(
#' Fetches the data
#'
#' @details
#' `fetch` usually returns the data in tibble format, but a few of the endpoints
#' only support the JSON classic format (delphi, pvt_meta_norostat, and meta).
#' In that case a JSON-like nested list structure is returned instead.
#' `fetch` usually returns the data in tibble format, but a few of the
#' endpoints only support the JSON classic format (`pub_delphi`,
#' `pvt_meta_norostat`, and `pub_meta`). In that case a
#' JSON-like nested list structure is returned instead.
#'
#' @rdname epidata_call
#' @param epidata_call an instance of `epidata_call`
Expand Down
3 changes: 3 additions & 0 deletions man/covidcast_epidata.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions man/epidata_call.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion man/pub_fluview_meta.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/pvt_norostat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/pvt_sensors.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/pvt_twitter.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/set_cache.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b1917e9

Please sign in to comment.