Introduce execution condition for examples

tidy-intelligence · Nov 3, 2024 · 1da17bd · 1da17bd
1 parent cb67930
commit 1da17bd
Show file tree

Hide file tree

Showing 22 changed files with 39 additions and 31 deletions.
diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
@@ -51,4 +51,3 @@ jobs:
       - uses: r-lib/actions/check-r-package@v2
         with:
           upload-snapshots: true
-          args: 'c("--no-manual","--no-examples")'
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -24,6 +24,7 @@ Imports:
     tidyr (>= 1.0.0),
     rlang (>= 1.0.0)
 Suggests:
+    curl,
     knitr,
     rmarkdown,
     testthat (>= 3.2.0)

diff --git a/R/wdi_get.R b/R/wdi_get.R
@@ -48,7 +48,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf curl::has_internet()
 #' # Download single indicator for multiple geographies
 #' wdi_get(c("US", "CA", "GB"), "NY.GDP.PCAP.KD")
 #'

diff --git a/R/wdi_get_geographies.R b/R/wdi_get_geographies.R
@@ -48,9 +48,9 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf curl::has_internet()
 #' # Download all geographies in English
-#' wdi_get_geographies(language = "en")
+#' wdi_get_geographies()
 #'
 #' # Download all geographies in Spanish
 #' wdi_get_geographies(language = "zh")

diff --git a/R/wdi_get_income_levels.R b/R/wdi_get_income_levels.R
@@ -23,7 +23,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf curl::has_internet()
 #' # Download all income levels in English
 #' wdi_get_income_levels()
 #'

diff --git a/R/wdi_get_indicators.R b/R/wdi_get_indicators.R
@@ -32,10 +32,9 @@
 #'
 #' @export
 #'
-#' @examples
-#'
+#' @examplesIf curl::has_internet()
 #' # Download all supported indicators in English
-#' wdi_get_indicators(language = "en")
+#' wdi_get_indicators()
 #'
 #' # Download all supported indicators in Spanish
 #' wdi_get_indicators(language = "es")

diff --git a/R/wdi_get_languages.R b/R/wdi_get_languages.R
@@ -18,7 +18,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf curl::has_internet()
 #' # Download all languages
 #' wdi_get_languages()
 #'

diff --git a/R/wdi_get_lending_types.R b/R/wdi_get_lending_types.R
@@ -22,7 +22,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf curl::has_internet()
 #' # Download all lending types in English
 #' wdi_get_lending_types()
 #'

diff --git a/R/wdi_get_regions.R b/R/wdi_get_regions.R
@@ -25,7 +25,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf curl::has_internet()
 #' # Download all regions
 #' wdi_get_regions()
 #'

diff --git a/R/wdi_get_sources.R b/R/wdi_get_sources.R
@@ -28,8 +28,8 @@
 #'
 #' @export
 #'
-#' @examples
-#' # Download all supported data sources
+#' @examplesIf curl::has_internet()
+#' # Download all available data sources in English
 #' wdi_get_sources()
 #'
 wdi_get_sources <- function(language = "en") {

diff --git a/R/wdi_get_topics.R b/R/wdi_get_topics.R
@@ -22,8 +22,8 @@
 #'
 #' @export
 #'
-#' @examples
-#' # Download all topics
+#' @examplesIf curl::has_internet()
+#' # Download all available topics in English
 #' wdi_get_topics()
 #'
 wdi_get_topics <- function(language = "en") {

diff --git a/R/wdi_search.R b/R/wdi_search.R
@@ -19,7 +19,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf curl::has_internet()
 #' # Download indicators
 #' indicators <- wdi_get_indicators()
 #'

diff --git a/man/wdi_get.Rd b/man/wdi_get.Rd
diff --git a/man/wdi_get_geographies.Rd b/man/wdi_get_geographies.Rd
diff --git a/man/wdi_get_income_levels.Rd b/man/wdi_get_income_levels.Rd
diff --git a/man/wdi_get_indicators.Rd b/man/wdi_get_indicators.Rd
diff --git a/man/wdi_get_languages.Rd b/man/wdi_get_languages.Rd
diff --git a/man/wdi_get_lending_types.Rd b/man/wdi_get_lending_types.Rd
diff --git a/man/wdi_get_regions.Rd b/man/wdi_get_regions.Rd
diff --git a/man/wdi_get_sources.Rd b/man/wdi_get_sources.Rd
diff --git a/man/wdi_get_topics.Rd b/man/wdi_get_topics.Rd
diff --git a/man/wdi_search.Rd b/man/wdi_search.Rd