docs: switch assignment operator in examples from = to <-

GIScience · Sep 20, 2024 · 566bf2d · 566bf2d
1 parent 9d66a65
commit 566bf2d
Show file tree

Hide file tree

Showing 16 changed files with 34 additions and 46 deletions.
diff --git a/R/directions.R b/R/directions.R
@@ -16,7 +16,7 @@
 #' @template return-parsed
 #' @template return-sf
 #' @examples
-#' coordinates = list(c(8.34234, 48.23424), c(8.34423, 48.26424))
+#' coordinates <- list(c(8.34234, 48.23424), c(8.34423, 48.26424))
 #'
 #' # simple call
 #' ors_directions(coordinates, preference="fastest")

diff --git a/R/elevation.R b/R/elevation.R
@@ -17,7 +17,6 @@
 #' @template return-parsed
 #' @template return-sf
 #' @examples
-#'
 #' # point coordinates
 #' coordinates <- c(13.349762, 38.11295)
 #' ors_elevation("point", coordinates)
@@ -32,7 +31,6 @@
 #'   c(12.638397, 37.645772)
 #' )
 #' ors_elevation("polyline", coordinates, format_out = "encodedpolyline")
-#'
 #' @template author
 #' @importFrom httr add_headers
 #' @export

diff --git a/R/geocode.R b/R/geocode.R
@@ -19,24 +19,21 @@
 #'   tag which surrounds the given coordinate.
 #' @template author
 #' @examples
-#'
 #' ## locations of Heidelberg around the globe
-#' x = ors_geocode("Heidelberg")
-#'
-#' ## set the number of results returne
+#' x <- ors_geocode("Heidelberg")
 #'
-#' x = ors_geocode("Heidelberg", size = 1)
+#' ## set the number of results returned
+#' x <- ors_geocode("Heidelberg", size = 1)
 #'
 #' ## search within a particular country
 #' ors_geocode("Heidelberg", boundary.country = "DE")
 #'
 #' ## structured geocoding
-#' x = ors_geocode(list(locality="Heidelberg", county="Heidelberg"))
+#' x <- ors_geocode(list(locality="Heidelberg", county="Heidelberg"))
 #'
 #' ## reverse geocoding
-#' location = x$features[[1L]]$geometry$coordinates
-#' y = ors_geocode(location = location, layers = "locality", size = 1)
-#'
+#' location <- x$features[[1L]]$geometry$coordinates
+#' y <- ors_geocode(location = location, layers = "locality", size = 1)
 #' @export
 ors_geocode <- function(query,
                         location,

diff --git a/R/matrix.R b/R/matrix.R
@@ -15,15 +15,15 @@
 #' @template return-text
 #' @template return-parsed
 #' @examples
-#' coordinates = list(
+#' coordinates <- list(
 #'   c(9.970093, 48.477473),
 #'   c(9.207916, 49.153868),
 #'   c(37.573242, 55.801281),
 #'   c(115.663757,38.106467)
 #' )
 #'
 #' # query for duration and distance in km
-#' res = ors_matrix(coordinates, metrics = c("duration", "distance"), units = "km")
+#' res <- ors_matrix(coordinates, metrics = c("duration", "distance"), units = "km")
 #'
 #' # duration in hours
 #' res$durations / 3600

diff --git a/R/optimization.R b/R/optimization.R
@@ -18,7 +18,7 @@
 #' @examples
 #' home_base <- c(2.35044, 48.71764)
 #'
-#' vehicles = vehicles(
+#' vehicles <- vehicles(
 #'   id = 1:2,
 #'   profile = "driving-car",
 #'   start = home_base,
@@ -37,7 +37,7 @@
 #'   c(2.89357, 48.90736)
 #' )
 #'
-#' jobs = jobs(
+#' jobs <- jobs(
 #'   id = 1:6,
 #'   service = 300,
 #'   amount = 1,

diff --git a/R/pois.R b/R/pois.R
@@ -28,8 +28,8 @@
 #' ors_pois('list')
 #'
 #' # POIs around a buffered point
-#' geometry = list(geojson = list(type = "Point",
-#'                                coordinates = c(8.8034, 53.0756)),
+#' geometry <- list(geojson = list(type = "Point",
+#'                                 coordinates = c(8.8034, 53.0756)),
 #'                 buffer = 100)
 #' ors_pois(geometry = geometry)
 #'

diff --git a/R/snap.R b/R/snap.R
@@ -16,15 +16,14 @@
 #' @template return-parsed
 #' @template return-sf
 #' @examples
-#' locations = list(
+#' locations <- list(
 #'   c(8.669629, 49.413025),
 #'   c(8.675841, 49.418532),
 #'   c(8.665144, 49.415594)
 #' )
 #'
-#' # query for duration and distance in km
-#' res = ors_snap(locations, radius = 350)
-#'
+#' # query for locations snapped onto the OpenStreetMap road network
+#' res <- ors_snap(locations, radius = 350)
 #' @template author
 #' @export
 ors_snap <- function(locations,

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ allows you to painlessly consume the following services:
 -   [isochrones](https://openrouteservice.org/dev/#/api-docs/v2/isochrones/%7Bprofile%7D/post)
     (accessibility)
 -   time-distance
-    [matrix](https://openrouteservice.org/dev/#/api-docs/v2/matrix/%7Bprofile%7D/post)
+    [matrices](https://openrouteservice.org/dev/#/api-docs/v2/matrix/%7Bprofile%7D/post)
 -   [snapping](https://openrouteservice.org/dev/#/api-docs/v2/snap/%7Bprofile%7D/post)
     to ways
 -   [pois](https://openrouteservice.org/dev/#/api-docs/pois/post)

diff --git a/man/ors_directions.Rd b/man/ors_directions.Rd
diff --git a/man/ors_elevation.Rd b/man/ors_elevation.Rd
diff --git a/man/ors_geocode.Rd b/man/ors_geocode.Rd
diff --git a/man/ors_matrix.Rd b/man/ors_matrix.Rd
diff --git a/man/ors_optimization.Rd b/man/ors_optimization.Rd
diff --git a/man/ors_pois.Rd b/man/ors_pois.Rd
diff --git a/man/ors_snap.Rd b/man/ors_snap.Rd
diff --git a/vignettes/openrouteservice.Rmd b/vignettes/openrouteservice.Rmd
@@ -34,7 +34,7 @@ to painlessly consume the following services:
   - `r doc('directions')` (routing)
   - `r doc('geocode', label='geocoding')` powered by [Pelias](https://pelias.io)
   - `r doc('isochrones')` (accessibility)
-  - time-distance `r doc('matrix')`
+  - time-distance `r doc('matrix', label='matrices')`
   - `r doc('snap', label='snapping')` to ways
   - `r doc('pois')` (points of interest)
   - SRTM `r doc('elevation')` for point and lines geometries