From b532ceecf66411821bb68e04651ea6e97419282e Mon Sep 17 00:00:00 2001 From: dsweber2 Date: Fri, 8 Sep 2023 12:19:02 -0700 Subject: [PATCH 1/4] docs: minor fixes --- R/cache.R | 2 +- README.md | 2 +- man/clear_cache.Rd | 20 +++++++++++++++++++- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/R/cache.R b/R/cache.R index 5168cbda..f4bde3ef 100644 --- a/R/cache.R +++ b/R/cache.R @@ -187,7 +187,7 @@ set_cache <- function(cache_dir = NULL, #' } #' @param disable instead of setting a new cache, disable caching entirely; #' defaults to `FALSE` -#' @param ... arguments passed to `set_cache` +#' @inheritDotParams set_cache #' @seealso [`set_cache`] to start a new cache (and general caching info), #' [`disable_cache`] to only disable without deleting, and [`cache_info`] #' @export diff --git a/README.md b/README.md index a1d727b9..d7d46e71 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ Note that for the time being, the private endpoints (i.e. those prefixed with `pvt`) will require a separate key that needs to be passed as an argument. [mit-image]: https://img.shields.io/badge/License-MIT-yellow.svg -[mit-url]: https://opensource.org/license/mit +[mit-url]: https://opensource.org/license/mit/ [github-actions-image]: https://github.com/cmu-delphi/epidatr/workflows/ci/badge.svg [github-actions-url]: https://github.com/cmu-delphi/epidatr/actions diff --git a/man/clear_cache.Rd b/man/clear_cache.Rd index 7e938b9b..1aa5ba9b 100644 --- a/man/clear_cache.Rd +++ b/man/clear_cache.Rd @@ -10,7 +10,25 @@ clear_cache(disable = FALSE, ...) \item{disable}{instead of setting a new cache, disable caching entirely; defaults to \code{FALSE}} -\item{...}{arguments passed to \code{set_cache}} +\item{...}{ + Arguments passed on to \code{\link[=set_cache]{set_cache}} + \describe{ + \item{\code{cache_dir}}{the directory in which the cache is stored. By default, this +is \code{tools::R_user_dir()} if on R 4.0+, but must be specified for earlier +versions of R. The path can be either relative or absolute. The +environmental variable is \code{EPIDATR_CACHE_DIR}.} + \item{\code{days}}{the maximum length of time in days to keep any particular cached +call. By default this is \code{1}. The environmental variable is +\code{EPIDATR_CACHE_MAX_AGE_DAYS}.} + \item{\code{max_size}}{the size of the entire cache, in MB, at which to start +pruning entries. By default this is \code{1024}, or 1GB. The environmental +variable is \code{EPIDATR_CACHE_MAX_SIZE_MB}.} + \item{\code{logfile}}{where cachem's log of transactions is stored, relative to the +cache directory. By default, it is \code{"logfile.txt"}. The environmental +variable is \code{EPIDATR_CACHE_LOGFILE}.} + \item{\code{confirm}}{whether to confirm directory creation. default is \code{TRUE}; +should only be set in non-interactive scripts} + }} } \description{ Deletes the current cache and resets a new cache. Deletes local data! If you From 35704f20fa6bbbf47d34880bfdaf9db978e45f79 Mon Sep 17 00:00:00 2001 From: dsweber2 Date: Fri, 8 Sep 2023 12:26:48 -0700 Subject: [PATCH 2/4] fix: single quotes for package names in title/desc --- DESCRIPTION | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 506efe67..8a5dfbd0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: epidatr Type: Package -Title: Client for Delphi's Epidata API +Title: Client for Delphi's 'Epidata' API Version: 1.0.0 Authors@R: c( @@ -17,7 +17,7 @@ Authors@R: ) URL: https://cmu-delphi.github.io/epidatr/, https://github.com/cmu-delphi/epidatr BugReports: https://github.com/cmu-delphi/epidatr/issues -Description: R Client for Delphi's Epidata API. Tools for fetching data in various forms. +Description: R Client for Delphi's 'Epidata' API. Tools for fetching data in various forms. Depends: R (>= 3.5.0) License: MIT + file LICENSE Encoding: UTF-8 From 081261496d1b398d74a9bf47827a486b7652a751 Mon Sep 17 00:00:00 2001 From: dsweber2 Date: Fri, 8 Sep 2023 12:38:05 -0700 Subject: [PATCH 3/4] docs: correct return format --- R/endpoints.R | 56 +++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/R/endpoints.R b/R/endpoints.R index b95c3870..42c384b8 100644 --- a/R/endpoints.R +++ b/R/endpoints.R @@ -16,7 +16,7 @@ #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. #' See `fetch_args_list()` for details. -#' @return [`epidata_call`] +#' @return [`tibble`] #' #' @keywords endpoint #' @export @@ -76,7 +76,7 @@ pvt_cdc <- function(auth, locations, epiweeks, fetch_args = fetch_args_list()) { #' @param zip string. A 5-digit zip code. #' @param fips_code string. A 5-digit fips county code, zero-padded. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' #' @seealso [`pub_covid_hosp_facility()`] #' @keywords endpoint @@ -161,7 +161,7 @@ pub_covid_hosp_facility_lookup <- function( #' @param ... not used for values, forces later arguments to bind by name #' @param publication_dates [`timeset`]. Publication dates to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' #' #' @seealso [`pub_covid_hosp_facility()`], [`epirange()`] @@ -464,7 +464,7 @@ pub_covid_hosp_facility <- function( #' most recent issue is returned. #' @param ... not used for values, forces later arguments to bind by name #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' #' @keywords endpoint #' @export @@ -610,7 +610,7 @@ pub_covid_hosp_state_timeseries <- function(states, dates, ..., issues = NULL, f #' #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. #' -#' @return [`epidata_call`] +#' @return [`tibble`] #' #' #' @examples @@ -696,7 +696,7 @@ pub_covidcast_meta <- function(fetch_args = fetch_args_list()) { #' the most recent issue is returned. Mutually exclusive with `as_of` or #' `issues`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' #' #' @seealso [pub_covidcast_meta()], [covidcast_epidata()], [epirange()] @@ -795,7 +795,7 @@ pub_covidcast <- function( #' @param system character. System name to fetch. #' @param epiweek [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`json`] #' @keywords endpoint #' @export pub_delphi <- function(system, epiweek, fetch_args = fetch_args_list()) { @@ -829,7 +829,7 @@ pub_delphi <- function(system, epiweek, fetch_args = fetch_args_list()) { #' @param locations character. Locations to fetch. #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_dengue_nowcast <- function(locations, epiweeks, fetch_args = fetch_args_list()) { @@ -867,7 +867,7 @@ pub_dengue_nowcast <- function(locations, epiweeks, fetch_args = fetch_args_list #' @param locations character. Locations to fetch. #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pvt_dengue_sensors <- function(auth, names, locations, epiweeks, fetch_args = fetch_args_list()) { @@ -917,7 +917,7 @@ pvt_dengue_sensors <- function(auth, names, locations, epiweeks, fetch_args = fe #' @param lag integer. Optionally, the lag of the issues to fetch. If not set, #' the most recent issue is returned. Mutually exclusive with `issues`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_ecdc_ili <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fetch_args = fetch_args_list()) { @@ -974,7 +974,7 @@ pub_ecdc_ili <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fetc #' @param lag integer. Optionally, the lag of the issues to fetch. If not set, #' the most recent issue is returned. Mutually exclusive with `issues`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_flusurv <- function(locations, epiweeks, ..., issues = NULL, lag = NULL, fetch_args = fetch_args_list()) { @@ -1030,7 +1030,7 @@ pub_flusurv <- function(locations, epiweeks, ..., issues = NULL, lag = NULL, fet #' @param lag integer. Optionally, the lag of the issues to fetch. If not set, #' the most recent issue is returned. Mutually exclusive with `issues`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_fluview_clinical <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fetch_args = fetch_args_list()) { @@ -1078,7 +1078,7 @@ pub_fluview_clinical <- function(regions, epiweeks, ..., issues = NULL, lag = NU #' #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. #' -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_fluview_meta <- function(fetch_args = fetch_args_list()) { @@ -1123,7 +1123,7 @@ pub_fluview_meta <- function(fetch_args = fetch_args_list()) { #' @param auth string. Optionally, restricted access key (not the same as API #' key). #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_fluview <- function( @@ -1198,7 +1198,7 @@ pub_fluview <- function( #' @param epiweeks [`timeset`] Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. #' -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_gft <- function(locations, epiweeks, fetch_args = fetch_args_list()) { @@ -1235,7 +1235,7 @@ pub_gft <- function(locations, epiweeks, fetch_args = fetch_args_list()) { #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param query string. The query to be fetched. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pvt_ght <- function(auth, locations, epiweeks, query, fetch_args = fetch_args_list()) { @@ -1277,7 +1277,7 @@ pvt_ght <- function(auth, locations, epiweeks, query, fetch_args = fetch_args_li #' @param lag integer. Optionally, the lag of the issues to fetch. If not set, #' the most recent issue is returned. Mutually exclusive with `issues`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_kcdc_ili <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fetch_args = fetch_args_list()) { @@ -1320,7 +1320,7 @@ pub_kcdc_ili <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fetc #' } #' @param auth string. Restricted access key (not the same as API key). #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`json`] #' @keywords endpoint #' @export pvt_meta_norostat <- function(auth, fetch_args = fetch_args_list()) { @@ -1339,7 +1339,7 @@ pvt_meta_norostat <- function(auth, fetch_args = fetch_args_list()) { #' #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. #' -#' @return [`epidata_call`] +#' @return [`json`] #' @keywords endpoint #' @export pub_meta <- function(fetch_args = fetch_args_list()) { @@ -1367,7 +1367,7 @@ pub_meta <- function(fetch_args = fetch_args_list()) { #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. #' -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_nidss_dengue <- function(locations, epiweeks, fetch_args = fetch_args_list()) { @@ -1406,7 +1406,7 @@ pub_nidss_dengue <- function(locations, epiweeks, fetch_args = fetch_args_list() #' @param lag integer. Optionally, the lag of the issues to fetch. If not set, #' the most recent issue is returned. Mutually exclusive with `issues`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_nidss_flu <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fetch_args = fetch_args_list()) { @@ -1458,7 +1458,7 @@ pub_nidss_flu <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fet #' @param locations character. Locations to fetch. #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pvt_norostat <- function(auth, locations, epiweeks, fetch_args = fetch_args_list()) { @@ -1499,7 +1499,7 @@ pvt_norostat <- function(auth, locations, epiweeks, fetch_args = fetch_args_list #' @param locations character. Locations to fetch. #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_nowcast <- function(locations, epiweeks, fetch_args = fetch_args_list()) { @@ -1535,7 +1535,7 @@ pub_nowcast <- function(locations, epiweeks, fetch_args = fetch_args_list()) { #' @param lag integer. Optionally, the lag of the issues to fetch. If not set, #' the most recent issue is returned. Mutually exclusive with `issues`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_paho_dengue <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, fetch_args = fetch_args_list()) { @@ -1586,7 +1586,7 @@ pub_paho_dengue <- function(regions, epiweeks, ..., issues = NULL, lag = NULL, f #' @param locations character. Locations to fetch. #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pvt_quidel <- function(auth, locations, epiweeks, fetch_args = fetch_args_list()) { @@ -1628,7 +1628,7 @@ pvt_quidel <- function(auth, locations, epiweeks, fetch_args = fetch_args_list() #' @param locations character. Locations to fetch. #' @param epiweeks [`timeset`]. Epiweeks to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pvt_sensors <- function(auth, names, locations, epiweeks, fetch_args = fetch_args_list()) { @@ -1674,7 +1674,7 @@ pvt_sensors <- function(auth, names, locations, epiweeks, fetch_args = fetch_arg #' @param epiweeks [`timeset`]. Epiweeks to fetch. Mutually exclusive with #' `dates`. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pvt_twitter <- function(auth, locations, ..., dates = NULL, epiweeks = NULL, fetch_args = fetch_args_list()) { @@ -1727,7 +1727,7 @@ pvt_twitter <- function(auth, locations, ..., dates = NULL, epiweeks = NULL, fet #' @param language string. Language to fetch. #' @param hours integer. Optionally, the hours to fetch. #' @param fetch_args [`fetch_args`]. Additional arguments to pass to `fetch()`. -#' @return [`epidata_call`] +#' @return [`tibble`] #' @keywords endpoint #' @export pub_wiki <- function( From 44c87309c66e6fd2dea54409edb253f12240be40 Mon Sep 17 00:00:00 2001 From: dsweber2 Date: Fri, 8 Sep 2023 19:39:54 +0000 Subject: [PATCH 4/4] docs: document (GHA) --- man/epidatr-package.Rd | 4 ++-- man/pub_covid_hosp_facility.Rd | 2 +- man/pub_covid_hosp_facility_lookup.Rd | 2 +- man/pub_covid_hosp_state_timeseries.Rd | 2 +- man/pub_covidcast.Rd | 2 +- man/pub_covidcast_meta.Rd | 2 +- man/pub_delphi.Rd | 2 +- man/pub_dengue_nowcast.Rd | 2 +- man/pub_ecdc_ili.Rd | 2 +- man/pub_flusurv.Rd | 2 +- man/pub_fluview.Rd | 2 +- man/pub_fluview_clinical.Rd | 2 +- man/pub_fluview_meta.Rd | 2 +- man/pub_gft.Rd | 2 +- man/pub_kcdc_ili.Rd | 2 +- man/pub_meta.Rd | 2 +- man/pub_nidss_dengue.Rd | 2 +- man/pub_nidss_flu.Rd | 2 +- man/pub_nowcast.Rd | 2 +- man/pub_paho_dengue.Rd | 2 +- man/pub_wiki.Rd | 2 +- man/pvt_cdc.Rd | 2 +- man/pvt_dengue_sensors.Rd | 2 +- man/pvt_ght.Rd | 2 +- man/pvt_meta_norostat.Rd | 2 +- man/pvt_norostat.Rd | 2 +- man/pvt_quidel.Rd | 2 +- man/pvt_sensors.Rd | 2 +- man/pvt_twitter.Rd | 2 +- 29 files changed, 30 insertions(+), 30 deletions(-) diff --git a/man/epidatr-package.Rd b/man/epidatr-package.Rd index ae5695fa..f957f50b 100644 --- a/man/epidatr-package.Rd +++ b/man/epidatr-package.Rd @@ -4,9 +4,9 @@ \name{epidatr-package} \alias{epidatr} \alias{epidatr-package} -\title{epidatr: Client for Delphi's Epidata API} +\title{epidatr: Client for Delphi's 'Epidata' API} \description{ -R Client for Delphi's Epidata API. Tools for fetching data in various forms. +R Client for Delphi's 'Epidata' API. Tools for fetching data in various forms. } \seealso{ Useful links: diff --git a/man/pub_covid_hosp_facility.Rd b/man/pub_covid_hosp_facility.Rd index 762d97f3..03ccc6fd 100644 --- a/man/pub_covid_hosp_facility.Rd +++ b/man/pub_covid_hosp_facility.Rd @@ -24,7 +24,7 @@ pub_covid_hosp_facility( \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: diff --git a/man/pub_covid_hosp_facility_lookup.Rd b/man/pub_covid_hosp_facility_lookup.Rd index c416dee9..b809571f 100644 --- a/man/pub_covid_hosp_facility_lookup.Rd +++ b/man/pub_covid_hosp_facility_lookup.Rd @@ -30,7 +30,7 @@ pub_covid_hosp_facility_lookup( \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: diff --git a/man/pub_covid_hosp_state_timeseries.Rd b/man/pub_covid_hosp_state_timeseries.Rd index 6cedca3f..72b55908 100644 --- a/man/pub_covid_hosp_state_timeseries.Rd +++ b/man/pub_covid_hosp_state_timeseries.Rd @@ -25,7 +25,7 @@ most recent issue is returned.} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/covid_hosp.html}. diff --git a/man/pub_covidcast.Rd b/man/pub_covidcast.Rd index ae1c39f9..71bfeba7 100644 --- a/man/pub_covidcast.Rd +++ b/man/pub_covidcast.Rd @@ -54,7 +54,7 @@ the most recent issue is returned. Mutually exclusive with \code{as_of} or \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/covidcast.html} diff --git a/man/pub_covidcast_meta.Rd b/man/pub_covidcast_meta.Rd index b8c440c7..54723cbc 100644 --- a/man/pub_covidcast_meta.Rd +++ b/man/pub_covidcast_meta.Rd @@ -10,7 +10,7 @@ pub_covidcast_meta(fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: diff --git a/man/pub_delphi.Rd b/man/pub_delphi.Rd index b877b38d..cec1d2db 100644 --- a/man/pub_delphi.Rd +++ b/man/pub_delphi.Rd @@ -14,7 +14,7 @@ pub_delphi(system, epiweek, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{json}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/delphi.html} diff --git a/man/pub_dengue_nowcast.Rd b/man/pub_dengue_nowcast.Rd index b2c6cb24..6c542ac8 100644 --- a/man/pub_dengue_nowcast.Rd +++ b/man/pub_dengue_nowcast.Rd @@ -14,7 +14,7 @@ pub_dengue_nowcast(locations, epiweeks, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/dengue_nowcast.html} diff --git a/man/pub_ecdc_ili.Rd b/man/pub_ecdc_ili.Rd index 634e3762..f06ec619 100644 --- a/man/pub_ecdc_ili.Rd +++ b/man/pub_ecdc_ili.Rd @@ -29,7 +29,7 @@ the most recent issue is returned. Mutually exclusive with \code{issues}.} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/ecdc_ili.html}. diff --git a/man/pub_flusurv.Rd b/man/pub_flusurv.Rd index 53cf550a..a54d8238 100644 --- a/man/pub_flusurv.Rd +++ b/man/pub_flusurv.Rd @@ -29,7 +29,7 @@ the most recent issue is returned. Mutually exclusive with \code{issues}.} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/flusurv.html}. diff --git a/man/pub_fluview.Rd b/man/pub_fluview.Rd index 0eb7954d..4d216a51 100644 --- a/man/pub_fluview.Rd +++ b/man/pub_fluview.Rd @@ -37,7 +37,7 @@ key).} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/fluview.html}. For diff --git a/man/pub_fluview_clinical.Rd b/man/pub_fluview_clinical.Rd index edfb096a..b593a270 100644 --- a/man/pub_fluview_clinical.Rd +++ b/man/pub_fluview_clinical.Rd @@ -31,7 +31,7 @@ the most recent issue is returned. Mutually exclusive with \code{issues}.} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/fluview_clinical.html} diff --git a/man/pub_fluview_meta.Rd b/man/pub_fluview_meta.Rd index 31beec17..28497a44 100644 --- a/man/pub_fluview_meta.Rd +++ b/man/pub_fluview_meta.Rd @@ -10,7 +10,7 @@ pub_fluview_meta(fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/fluview_meta.html} diff --git a/man/pub_gft.Rd b/man/pub_gft.Rd index 8bdc9742..fb986cad 100644 --- a/man/pub_gft.Rd +++ b/man/pub_gft.Rd @@ -14,7 +14,7 @@ pub_gft(locations, epiweeks, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/gft.html} diff --git a/man/pub_kcdc_ili.Rd b/man/pub_kcdc_ili.Rd index 5dd8453f..76fd71c8 100644 --- a/man/pub_kcdc_ili.Rd +++ b/man/pub_kcdc_ili.Rd @@ -29,7 +29,7 @@ the most recent issue is returned. Mutually exclusive with \code{issues}.} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/kcdc_ili.html} diff --git a/man/pub_meta.Rd b/man/pub_meta.Rd index 46be9d86..bfb12db4 100644 --- a/man/pub_meta.Rd +++ b/man/pub_meta.Rd @@ -10,7 +10,7 @@ pub_meta(fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{json}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/meta.html} diff --git a/man/pub_nidss_dengue.Rd b/man/pub_nidss_dengue.Rd index ae6bc1d5..b2cb49f9 100644 --- a/man/pub_nidss_dengue.Rd +++ b/man/pub_nidss_dengue.Rd @@ -14,7 +14,7 @@ pub_nidss_dengue(locations, epiweeks, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/nidss_dengue.html} diff --git a/man/pub_nidss_flu.Rd b/man/pub_nidss_flu.Rd index f1b12d36..f9b43d01 100644 --- a/man/pub_nidss_flu.Rd +++ b/man/pub_nidss_flu.Rd @@ -29,7 +29,7 @@ the most recent issue is returned. Mutually exclusive with \code{issues}.} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/nidss_flu.html} diff --git a/man/pub_nowcast.Rd b/man/pub_nowcast.Rd index 0a56e416..7127371a 100644 --- a/man/pub_nowcast.Rd +++ b/man/pub_nowcast.Rd @@ -14,7 +14,7 @@ pub_nowcast(locations, epiweeks, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/nowcast.html}. diff --git a/man/pub_paho_dengue.Rd b/man/pub_paho_dengue.Rd index 68b9659c..4db0ea03 100644 --- a/man/pub_paho_dengue.Rd +++ b/man/pub_paho_dengue.Rd @@ -29,7 +29,7 @@ the most recent issue is returned. Mutually exclusive with \code{issues}.} \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/paho_dengue.html} diff --git a/man/pub_wiki.Rd b/man/pub_wiki.Rd index ce925ce9..88c8683d 100644 --- a/man/pub_wiki.Rd +++ b/man/pub_wiki.Rd @@ -31,7 +31,7 @@ pub_wiki( \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/wiki.html} diff --git a/man/pvt_cdc.Rd b/man/pvt_cdc.Rd index 0484249c..59fff50f 100644 --- a/man/pvt_cdc.Rd +++ b/man/pvt_cdc.Rd @@ -17,7 +17,7 @@ pvt_cdc(auth, locations, epiweeks, fetch_args = fetch_args_list()) See \code{fetch_args_list()} for details.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/cdc.html} diff --git a/man/pvt_dengue_sensors.Rd b/man/pvt_dengue_sensors.Rd index 426a2cc3..c28cc275 100644 --- a/man/pvt_dengue_sensors.Rd +++ b/man/pvt_dengue_sensors.Rd @@ -24,7 +24,7 @@ pvt_dengue_sensors( \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/dengue_sensors.html} diff --git a/man/pvt_ght.Rd b/man/pvt_ght.Rd index f299da3f..6b370427 100644 --- a/man/pvt_ght.Rd +++ b/man/pvt_ght.Rd @@ -18,7 +18,7 @@ pvt_ght(auth, locations, epiweeks, query, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/ght.html} diff --git a/man/pvt_meta_norostat.Rd b/man/pvt_meta_norostat.Rd index 6a4ff8c5..ae4f777a 100644 --- a/man/pvt_meta_norostat.Rd +++ b/man/pvt_meta_norostat.Rd @@ -12,7 +12,7 @@ pvt_meta_norostat(auth, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{json}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/meta_norostat.html} diff --git a/man/pvt_norostat.Rd b/man/pvt_norostat.Rd index a8588874..80855af8 100644 --- a/man/pvt_norostat.Rd +++ b/man/pvt_norostat.Rd @@ -16,7 +16,7 @@ pvt_norostat(auth, locations, epiweeks, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/norostat.html} diff --git a/man/pvt_quidel.Rd b/man/pvt_quidel.Rd index a1842ac9..9e9399fc 100644 --- a/man/pvt_quidel.Rd +++ b/man/pvt_quidel.Rd @@ -16,7 +16,7 @@ pvt_quidel(auth, locations, epiweeks, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/quidel.html} diff --git a/man/pvt_sensors.Rd b/man/pvt_sensors.Rd index 1f73397e..91c31b73 100644 --- a/man/pvt_sensors.Rd +++ b/man/pvt_sensors.Rd @@ -18,7 +18,7 @@ pvt_sensors(auth, names, locations, epiweeks, fetch_args = fetch_args_list()) \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/sensors.html} diff --git a/man/pvt_twitter.Rd b/man/pvt_twitter.Rd index 04742c8d..a10870a3 100644 --- a/man/pvt_twitter.Rd +++ b/man/pvt_twitter.Rd @@ -28,7 +28,7 @@ pvt_twitter( \item{fetch_args}{\code{\link{fetch_args}}. Additional arguments to pass to \code{fetch()}.} } \value{ -\code{\link{epidata_call}} +\code{\link{tibble}} } \description{ API docs: \url{https://cmu-delphi.github.io/delphi-epidata/api/twitter.html}