docs: It adds conditions to run the examples to replace \dontrun

It solves #208.

Author: JavierMtzRdz

DESCRIPTION

@@ -57,7 +57,8 @@ Suggests:
     readr,
     rmarkdown,
     testthat (>= 3.1.5),
-    withr
+    withr,
+    curl
 VignetteBuilder:
     knitr
 Remotes:

R/endpoints.R

@@ -47,14 +47,12 @@ NULL
 #' @description
 #' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/cdc.html>
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("SECRET_API_AUTH_CDC") != ""
 #' pvt_cdc(
 #'   auth = Sys.getenv("SECRET_API_AUTH_CDC"),
 #'   locations = "fl,ca",
 #'   epirange(201501, 201601)
 #' )
-#' }
 #'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
@@ -111,11 +109,11 @@ pvt_cdc <- function(
 #' @details Only one location argument needs to be specified.
 #' Combinations of the arguments are not currently supported.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_covid_hosp_facility_lookup(state = "fl")
 #' pub_covid_hosp_facility_lookup(city = "southlake")
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @param state string. A two-letter character state abbreviation.
 #' @param ccn string. A facility CMS certification number.
@@ -196,8 +194,8 @@ pub_covid_hosp_facility_lookup <- function(
 #' @details Starting October 1, 2022, some facilities are only required to
 #' report annually.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_covid_hosp_facility(
 #'   hospital_pks = "100075",
 #'   collection_weeks = epirange(20200101, 20200501)
@@ -207,7 +205,7 @@ pub_covid_hosp_facility_lookup <- function(
 #'   hospital_pks = "050063",
 #'   collection_weeks = epirange(20240101, 20240301)
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @param hospital_pks character. Facility identifiers.
 #' @param collection_weeks [`timeset`]. Dates (corresponding to epiweeks) to
@@ -584,13 +582,13 @@ pub_covid_hosp_facility <- function(
 #' @details Starting October 1, 2022, some facilities are only required to
 #' report annually.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_covid_hosp_state_timeseries(
 #'   states = "fl",
 #'   dates = epirange(20200101, 20200501)
 #' )
-#' }
+#'
 #'
 #' @inheritParams .epidatr_shared_params
 #'
@@ -920,10 +918,9 @@ pub_covid_hosp_state_timeseries <- function(
 #'
 #' @return [`tibble::tibble`]
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_covidcast_meta()
-#' }
 #'
 #' @seealso [pub_covidcast()],[covidcast_epidata()]
 #' @keywords endpoint
@@ -969,8 +966,8 @@ pub_covidcast_meta <- function(fetch_args = fetch_args_list()) {
 #' link above for more. Delphi's [COVIDcast public
 #' dashboard](https://delphi.cmu.edu/covidcast/) is powered by this endpoint.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_covidcast(
 #'   source = "jhu-csse",
 #'   signals = "confirmed_7dav_incidence_prop",
@@ -987,7 +984,6 @@ pub_covidcast_meta <- function(fetch_args = fetch_args_list()) {
 #'   geo_values = "*",
 #'   time_values = epirange(20200601, 20200801)
 #' )
-#' }
 #'
 #' @inheritParams .epidatr_shared_params
 #' @param source string. The data source to query (see:
@@ -1147,13 +1143,13 @@ pub_delphi <- function(
 #' @description
 #' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/dengue_nowcast.html>
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_dengue_nowcast(
 #'   locations = "pr",
 #'   epiweeks = epirange(201401, 202301)
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #' @keywords endpoint
@@ -1185,15 +1181,15 @@ pub_dengue_nowcast <- function(
 #' @description
 #' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/dengue_sensors.html>
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("SECRET_API_AUTH_SENSORS") != ""
+#'
 #' pvt_dengue_sensors(
 #'   auth = Sys.getenv("SECRET_API_AUTH_SENSORS"),
 #'   names = "ght",
 #'   locations = "ag",
 #'   epiweeks = epirange(201501, 202001)
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #' @keywords endpoint
@@ -1241,10 +1237,10 @@ pvt_dengue_sensors <- function(
 #' @details The list of location argument can be found in
 #' <https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt>.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_ecdc_ili(regions = "austria", epiweeks = epirange(201901, 202001))
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #'
@@ -1366,10 +1362,10 @@ pub_flusurv <- function(
 #' @description
 #' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/fluview_clinical.html>
 #'
-#' @examples
-#' \dontrun{
-#' pub_fluview_clinical(regions = "nat", epiweeks = epirange(201601, 201701))
-#' }
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
+#'  pub_fluview_clinical(regions = "nat", epiweeks = epirange(201601, 201701))
+#'
 #' @inheritParams .epidatr_shared_params
 #' @param regions character. Locations to fetch. Can be any string IDs in
 #'   national, HHS region, census division, most states and territories, and so
@@ -1430,10 +1426,10 @@ pub_fluview_clinical <- function(
 #' @description
 #' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/fluview_meta.html>
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_fluview_meta()
-#' }
+#'
 #'
 #' @inheritParams .epidatr_shared_params
 #'
@@ -1467,10 +1463,10 @@ pub_fluview_meta <- function(fetch_args = fetch_args_list()) {
 #' @details The full list of location inputs can be accessed at
 #'   <https://github.com/cmu-delphi/delphi-epidata/blob/main/src/acquisition/fluview/fluview_locations.py>.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_fluview(regions = "nat", epiweeks = epirange(201201, 202005))
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @inheritParams pub_fluview_clinical
 #' @return [`tibble::tibble`]
@@ -1549,10 +1545,10 @@ pub_fluview <- function(
 #'   and
 #'   <https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt>.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_gft(locations = "hhs1", epiweeks = epirange(201201, 202001))
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #'
 #' @return [`tibble::tibble`]
@@ -1587,15 +1583,15 @@ pub_gft <- function(
 #'
 #' Estimate of influenza activity based on volume of certain search queries. …
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("SECRET_API_AUTH_GHT") != ""
+#'
 #' pvt_ght(
 #'   auth = Sys.getenv("SECRET_API_AUTH_GHT"),
 #'   locations = "ma",
 #'   epiweeks = epirange(199301, 202304),
 #'   query = "how to get over the flu"
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @param query string. The query to be fetched.
 #' @return [`tibble::tibble`]
@@ -1636,10 +1632,10 @@ pvt_ght <- function(
 #' @description
 #' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/kcdc_ili.html>
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_kcdc_ili(regions = "ROK", epiweeks = 200436)
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #'
@@ -1737,10 +1733,10 @@ pub_meta <- function(fetch_args = fetch_args_list()) {
 #' and
 #' <https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_locations.txt>.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_nidss_dengue(locations = "taipei", epiweeks = epirange(201201, 201301))
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #'
 #' @return [`tibble::tibble`]
@@ -1776,10 +1772,10 @@ pub_nidss_dengue <- function(
 #' Infectious Disease Statistical System.
 #'
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_nidss_flu(regions = "taipei", epiweeks = epirange(201501, 201601))
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #'
@@ -1840,14 +1836,14 @@ pub_nidss_flu <- function(
 #' This is the documentation of the API for accessing the NoroSTAT endpoint of
 #'   the Delphi’s epidemiological data.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("SECRET_API_AUTH_NOROSTAT") != ""
+#'
 #' pvt_norostat(
 #'   auth = Sys.getenv("SECRET_API_AUTH_NOROSTAT"),
 #'   locations = "Minnesota, Ohio, Oregon, Tennessee, and Wisconsin",
 #'   epiweeks = 201233
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @param locations character. Locations to fetch. Only a specific list of
 #' full state names are permitted. See the `locations` column in the
@@ -1892,10 +1888,10 @@ pvt_norostat <- function(
 #' @details The full list of location inputs can be accessed at
 #' <https://github.com/cmu-delphi/delphi-epidata/blob/main/src/acquisition/fluview/fluview_locations.py>.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_nowcast(locations = "ca", epiweeks = epirange(201201, 201301))
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #' @keywords endpoint
@@ -1927,10 +1923,10 @@ pub_nowcast <- function(
 #' @description
 #' API docs: <https://cmu-delphi.github.io/delphi-epidata/api/paho_dengue.html>
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_paho_dengue(regions = "ca", epiweeks = epirange(201401, 201501))
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #'
@@ -1987,14 +1983,14 @@ pub_paho_dengue <- function(
 #'
 #' Data provided by Quidel Corp., which contains flu lab test results.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("SECRET_API_AUTH_QUIDEL") != ""
+#'
 #' pvt_quidel(
 #'   auth = Sys.getenv("SECRET_API_AUTH_QUIDEL"),
 #'   epiweeks = epirange(201201, 202001),
 #'   locations = "hhs1"
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #' @keywords endpoint
@@ -2042,15 +2038,15 @@ pvt_quidel <- function(
 #'   these were designed to track ILI as driven by seasonal influenza, and were
 #'   NOT designed to track ILI during the COVID-19 pandemic.
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("SECRET_API_AUTH_SENSORS") != ""
+#'
 #' pvt_sensors(
 #'   auth = Sys.getenv("SECRET_API_AUTH_SENSORS"),
 #'   names = "sar3",
 #'   locations = "nat",
 #'   epiweeks = epirange(201501, 202001)
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #' @keywords endpoint
@@ -2095,15 +2091,15 @@ pvt_sensors <- function(
 #' Delphi’s epidemiological data. Sourced from
 #' [Healthtweets](http://www.healthtweets.org/)
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("SECRET_API_AUTH_TWITTER") != ""
+#'
 #' pvt_twitter(
 #'   auth = Sys.getenv("SECRET_API_AUTH_TWITTER"),
 #'   locations = "CA",
 #'   time_type = "week",
 #'   time_values = epirange(201501, 202001)
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @return [`tibble::tibble`]
 #' @keywords endpoint
@@ -2173,14 +2169,14 @@ pvt_twitter <- function(
 #' * Other resolution: By article (54)
 #' * Open access
 #'
-#' @examples
-#' \dontrun{
+#' @examplesIf curl::has_internet() && Sys.getenv("DELPHI_EPIDATA_KEY") != ""
+#'
 #' pub_wiki(
 #'   articles = "avian_influenza",
 #'   time_type = "week",
 #'   time_values = epirange(201501, 201601)
 #' )
-#' }
+#'
 #' @inheritParams .epidatr_shared_params
 #' @param articles character. Articles to fetch.
 #' @param language string. Language to fetch.