chore: do not run examples

Disable examples entirely in order to prevent them from being executed on CRAN. They were run before with `\donttest` which has been overridden by the option `--run-donttest`.

Author: aoles

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: openrouteservice
 Title: An 'openrouteservice' API Client
-Version: 0.6.1
+Version: 0.6.2
 Authors@R: c(
     person("Heidelberg Institute for Geoinformation Technology (HeiGIT) gGmbH", role = "cph"),
     person(c("Andrzej", "K."), "Oleś", email = "andrzej.oles@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-0285-2787"))

R/api_key.R

@@ -31,12 +31,13 @@ ors_api_key <- function (key, service = 'openrouteservice', username = NULL, key
     ## api key set in environment variable takes precedence over keyring
     if ( nchar(api_key_val) )
       api_key_val
-    else
-      if ( isTRUE(grepl("^https?://api.openrouteservice.org$", ors_url())) )
-        tryCatch(
-          key_get(service, username, keyring),
-          error = function(e)
-            stop(sprintf("API key not set.\n  Get your free key at %s\n  Use `ors_api_key('<your-api-key>')` to set it", signup_url()), call. = FALSE))
+    else if ( on_cran() )
+      NA
+    else if ( isTRUE(grepl("^https?://api.openrouteservice.org$", ors_url())) )
+      tryCatch(
+        key_get(service, username, keyring),
+        error = function(e)
+          stop(sprintf("API key not set.\n  Get your free key at %s\n  Use `ors_api_key('<your-api-key>')` to set it", signup_url()), call. = FALSE))
   }
   ## set key
   else

R/directions.R

@@ -16,18 +16,22 @@
 #' @template return-parsed
 #' @template return-sf
 #' @examples
-#' \donttest{coordinates <- list(c(8.34234, 48.23424), c(8.34423, 48.26424))
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' coordinates <- list(c(8.34234, 48.23424), c(8.34423, 48.26424))
 #'
 #' # simple call
-#' ors_directions(coordinates, preference="fastest")
+#' try( ors_directions(coordinates, preference="fastest") )
 #'
 #' # customized options
-#' ors_directions(coordinates, profile="cycling-mountain", elevation=TRUE)
+#' try( ors_directions(coordinates, profile="cycling-mountain", elevation=TRUE) )
 #'
 #' # list of locations as `data.frame` output as simple features `sf` object
 #' locations <- data.frame(lng = c(8.34234, 8.327807, 8.34423),
 #'                         lat = c(48.23424, 48.239368, 48.26424))
-#' ors_directions(locations, output = "sf")}
+#' try( ors_directions(locations, output = "sf") )
+#' }
 #' @template author
 #' @export
 ors_directions <- function(coordinates,

R/elevation.R

@@ -17,20 +17,24 @@
 #' @template return-parsed
 #' @template return-sf
 #' @examples
-#' \donttest{# point coordinates
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' # point coordinates
 #' coordinates <- c(13.349762, 38.11295)
-#' ors_elevation("point", coordinates)
+#' try( ors_elevation("point", coordinates) )
 #'
 #' # geojson as input
 #' point <- '{ "type": "Point", "coordinates": [13.349762, 38.11295] }'
-#' ors_elevation("geojson", point)
+#' try( ors_elevation("geojson", point) )
 #'
 #' # line geometry returned as encoded polyline
 #' coordinates <- list(
 #'   c(13.349762, 38.11295),
 #'   c(12.638397, 37.645772)
 #' )
-#' ors_elevation("polyline", coordinates, format_out = "encodedpolyline")}
+#' try( ors_elevation("polyline", coordinates, format_out = "encodedpolyline") )
+#' }
 #' @template author
 #' @importFrom httr add_headers
 #' @export

R/geocode.R

@@ -19,7 +19,10 @@
 #'   tag which surrounds the given coordinate.
 #' @template author
 #' @examples
-#' \donttest{## locations of Heidelberg around the globe
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' ## locations of Heidelberg around the globe
 #' x <- ors_geocode("Heidelberg")
 #'
 #' ## set the number of results returned
@@ -33,7 +36,8 @@
 #'
 #' ## reverse geocoding
 #' location <- x$features[[1L]]$geometry$coordinates
-#' y <- ors_geocode(location = location, layers = "locality", size = 1)}
+#' y <- ors_geocode(location = location, layers = "locality", size = 1)
+#' }
 #' @export
 ors_geocode <- function(query,
                         location,

R/isochrones.R

@@ -22,10 +22,14 @@
 #' @template return-parsed
 #' @template return-sf
 #' @examples
-#' \donttest{ors_isochrones(c(8.34234, 48.23424), interval=20)
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' ors_isochrones(c(8.34234, 48.23424), interval=20)
 #'
 #' locations <- list(c(8.681495, 49.41461), c(8.686507,49.41943))
-#' ors_isochrones(locations, range=c(300, 200))}
+#' ors_isochrones(locations, range=c(300, 200))
+#' }
 #' @template author
 #' @export
 ors_isochrones <- function(locations,

R/matrix.R

@@ -15,7 +15,10 @@
 #' @template return-text
 #' @template return-parsed
 #' @examples
-#' \donttest{coordinates <- list(
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' coordinates <- list(
 #'   c(9.970093, 48.477473),
 #'   c(9.207916, 49.153868),
 #'   c(37.573242, 55.801281),
@@ -29,7 +32,8 @@
 #' res$durations / 3600
 #'
 #' # distance in km
-#' res$distances}
+#' res$distances
+#' }
 #' @template author
 #' @export
 ors_matrix <- function(locations,

R/optimization.R

@@ -16,7 +16,10 @@
 #' @template return-text
 #' @template return-parsed
 #' @examples
-#' \donttest{home_base <- c(2.35044, 48.71764)
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' home_base <- c(2.35044, 48.71764)
 #'
 #' vehicles <- vehicles(
 #'   id = 1:2,
@@ -45,7 +48,8 @@
 #'   skills = list(1, 1, 2, 2, 14, 14)
 #' )
 #'
-#' ors_optimization(jobs, vehicles)}
+#' try( ors_optimization(jobs, vehicles) )
+#' }
 #' @template author
 #' @export
 ors_optimization <- function(jobs,

R/pois.R

@@ -24,7 +24,10 @@
 #' @template return-sf
 #' @templateVar valid_for `request = "pois"`
 #' @examples
-#' \donttest{# POI categories list
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' # POI categories list
 #' ors_pois('list')
 #'
 #' # POIs around a buffered point
@@ -54,7 +57,8 @@
 #'          ))
 #'
 #' # POI Statistics
-#' ors_pois("stats", geometry = geometry)}
+#' ors_pois("stats", geometry = geometry)
+#' }
 #' @template author
 #' @export
 ors_pois <- function(request = c('pois', 'stats', 'list'),

R/snap.R

@@ -16,14 +16,18 @@
 #' @template return-parsed
 #' @template return-sf
 #' @examples
-#' \donttest{locations <- list(
+#' # These examples might require interaction to query the local keyring, or
+#' # might fail due to network issues, so they are not run by default
+#' \dontrun{
+#' locations <- list(
 #'   c(8.669629, 49.413025),
 #'   c(8.675841, 49.418532),
 #'   c(8.665144, 49.415594)
 #' )
 #'
 #' # query for locations snapped onto the OpenStreetMap road network
-#' res <- ors_snap(locations, radius = 350)}
+#' res <- ors_snap(locations, radius = 350)
+#' }
 #' @template author
 #' @export
 ors_snap <- function(locations,