diff --git a/404.html b/404.html index 4abe716..3b7b092 100644 --- a/404.html +++ b/404.html @@ -19,7 +19,7 @@ - +
@@ -53,7 +53,7 @@
  • - +
  • @@ -64,7 +64,7 @@
    - +
    @@ -92,16 +92,16 @@

    Page not found (404)

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/LICENSE-text.html b/LICENSE-text.html index ee18dcb..5daf782 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -267,15 +267,15 @@

    License

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/articles/index.html b/articles/index.html index 9a8a839..e1575d3 100644 --- a/articles/index.html +++ b/articles/index.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -65,15 +65,15 @@

    All vignettes

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/articles/openrouteservice.html b/articles/openrouteservice.html index 387f5b6..4b9b9b2 100644 --- a/articles/openrouteservice.html +++ b/articles/openrouteservice.html @@ -13,14 +13,13 @@ - - +
    @@ -54,7 +53,7 @@
  • - +
  • @@ -65,7 +64,7 @@
    - + @@ -81,9 +80,9 @@

    Query openrouteservice from R

    Andrzej Oleś

    -

    2024-05-24

    +

    2024-09-18

    - Source: vignettes/openrouteservice.Rmd + Source: vignettes/openrouteservice.Rmd @@ -101,7 +100,7 @@

    Get starteddirections (routing)
  • -geocode +geocoding powered by Pelias
  • @@ -110,6 +109,9 @@

    Get startedmatrix

  • +snapping +to ways
  • +
  • pois (points of interest)
  • SRTM elevation @@ -184,7 +186,7 @@

    DirectionsaddGeoJSON(x, fill=FALSE) %>% fitBBox(x$bbox)
    -

    Other output formats, such as GPX, can be specified in the argument +

    Other output formats, such as GPX, can be specified in the argument format. Note that plain JSON response returns the geometry as Google’s encoded polyline,

    @@ -221,7 +223,7 @@

    DirectionsaddGeoJSON(x, fill=FALSE) %>% fitBBox(x$bbox)
    -

    Any optional query +

    Any optional query parameters can be specified by providing them as additional ... arguments to ors_directions. For example, in order to plot the elevation profile of a route colored by steepness @@ -329,7 +331,7 @@

    DirectionsaddGeoJSON(x, fill=FALSE) %>% fitBBox(x$bbox)
    - +
    -

    Here we have used sf output for the sake of some further +

    Here we have used sf output for the sake of some further postprocessing and visualization. By grouping the isochrones according to ranges we gain the ability of toggling individual ranges when displayed in mapview. Another @@ -400,7 +402,7 @@

    Isochronesmapview(isochrones, zcol = "value", col = pal, col.regions = pal, alpha.regions = 0.5, homebutton = FALSE)
    - +

    Matrix @@ -426,18 +428,18 @@

    Matrix # duration in hours (res$durations / 3600) %>% round(1)

    ##       [,1]  [,2] [,3]  [,4]
    -## [1,]   0.0   1.6 25.4 109.7
    -## [2,]   1.6   0.0 25.4 109.6
    -## [3,]  25.4  25.2  0.0  84.7
    -## [4,] 109.6 109.4 84.6   0.0
    +## [1,] 0.0 1.6 25.3 109.6 +## [2,] 1.6 0.0 25.3 109.5 +## [3,] 25.3 25.1 0.0 84.7 +## [4,] 109.5 109.4 84.6 0.0
     # distance in km
     res$distances %>% round
    ##      [,1] [,2] [,3] [,4]
    -## [1,]    0  154 2412 9779
    -## [2,]  154    0 2386 9753
    -## [3,] 2361 2337    0 7328
    -## [4,] 9713 9689 7313    0
    +## [1,] 0 154 2413 9780 +## [2,] 154 0 2387 9755 +## [3,] 2362 2338 0 7328 +## [4,] 9714 9690 7313 0

    Geocoding @@ -459,7 +461,7 @@

    GeocodingaddGeoJSON(x) %>% fitBBox(x$bbox)

    -
    +
     ## set the number of results returned
     x <- ors_geocode("Heidelberg", size = 1)
     
    @@ -535,7 +537,7 @@ 

    POIs ## $ information:List of 4 ## ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" ## ..$ version : chr "0.1" -## ..$ timestamp : int 1716585715 +## ..$ timestamp : int 1726651599 ## ..$ query :List of 5 ## .. ..$ request : chr "stats" ## .. ..$ limit : int 2000 @@ -650,15 +652,13 @@

    OptimizationaddAwesomeMarkers(data = home_base, icon = awesomeIcons("home")) %>% addRoutes(routes, c("purple", "green"))

    - +
    + @@ -671,16 +671,16 @@

    Optimization

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/authors.html b/authors.html index 1472981..928cd3b 100644 --- a/authors.html +++ b/authors.html @@ -3,7 +3,7 @@ - +
    @@ -34,14 +34,14 @@
    - +
    @@ -50,7 +50,7 @@

    Authors and Citation

    - +
    • Andrzej Oleś. Author, maintainer.

      @@ -59,20 +59,20 @@

      Authors and Citation

      Citation

      - Source: DESCRIPTION + Source: DESCRIPTION

      Oleś A (2024). openrouteservice: Openrouteservice API Client. -R package version 0.4.2, https://github.com/GIScience/openrouteservice-r. +R package version 0.5.0, https://github.com/GIScience/openrouteservice-r.

      @Manual{,
         title = {openrouteservice: Openrouteservice API Client},
         author = {Andrzej Oleś},
         year = {2024},
      -  note = {R package version 0.4.2},
      +  note = {R package version 0.5.0},
         url = {https://github.com/GIScience/openrouteservice-r},
       }
      @@ -87,15 +87,15 @@

      Citation

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/index.html b/index.html index 512b4ff..575acb9 100644 --- a/index.html +++ b/index.html @@ -20,7 +20,7 @@ - +
    @@ -54,7 +54,7 @@
  • - +
  • @@ -65,7 +65,7 @@
    - +
    @@ -79,13 +79,15 @@
  • directions (routing)
  • -geocode powered by Pelias +geocoding powered by Pelias
  • isochrones (accessibility)
  • time-distance matrix
  • +snapping to ways
  • +
  • pois (points of interest)
  • SRTM elevation for point and lines geometries
  • routing optimization based on Vroom @@ -120,41 +122,42 @@

    Local ORS instance geocode = "geocode", pois = "pois", elevation = "elevation", - optimization = "optimization"))

  • + optimization = "optimization", + snap = "v2/snap"))

    Package News

    -

    version 0.4.0 +

    version 0.5.0

    NEW FEATURES

      -
    • Enable optimization endpoint.
    • +
    • Enable snap endpoint.
    -

    version 0.3.3 +

    version 0.4.0

    -

    BUG FIXES +

    NEW FEATURES

      -
    • Fixed resolving of URL paths to endpoints.
    • +
    • Enable optimization endpoint.
    -

    version 0.3.2 +

    version 0.3.3

    -

    NEW FEATURES +

    BUG FIXES

      -
    • More descriptive messages for API response errors.
    • +
    • Fixed resolving of URL paths to endpoints.
    @@ -215,16 +218,16 @@

    Dev status

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/news/index.html b/news/index.html index 61d35a8..7816a75 100644 --- a/news/index.html +++ b/news/index.html @@ -3,7 +3,7 @@ - +
    @@ -34,22 +34,29 @@
    - +
    +
    + +
    +

    NEW FEATURES

    +
    • Enable snap endpoint.
    • +
    +
    @@ -166,15 +173,15 @@

    NEW FEATURES
    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/pkgdown.yml b/pkgdown.yml index 10f1e38..0266bbb 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,7 +1,6 @@ pandoc: 3.1.11 -pkgdown: 2.0.9 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: openrouteservice: openrouteservice.html -last_built: 2024-05-24T21:21Z - +last_built: 2024-09-18T09:26Z diff --git a/reference/fitBBox.html b/reference/fitBBox.html index 9f6c705..dec32af 100644 --- a/reference/fitBBox.html +++ b/reference/fitBBox.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -61,24 +61,24 @@

    Set Bounds of a Map Widget

    Arguments

    -
    map
    + + +
    map

    a map widget object created from leaflet()

    -
    bbox
    +
    bbox

    A vector c(lng1, lat1, lng2, lat2) specifying the bounding box coordinates

    Value

    - - -

    The modified map widget.

    +

    The modified map widget.

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -93,15 +93,15 @@

    Author

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/index.html b/reference/index.html index 068e0b6..e1d4078 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,9 +1,9 @@ -Function reference • openrouteservicePackage index • openrouteservice - +
    @@ -34,14 +34,14 @@
    - +
    @@ -93,6 +93,10 @@

    All functions ors_profile()

    Openrouteservice Profiles

    + +

    ors_snap()

    + +

    Openrouteservice Snapping

    print(<ors_api>)

    @@ -110,15 +114,15 @@

    All functions
    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_api_key.html b/reference/ors_api_key.html index 0342ff1..2b004b2 100644 --- a/reference/ors_api_key.html +++ b/reference/ors_api_key.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -61,20 +61,22 @@

    API key management

    Arguments

    -
    key
    + + +
    key

    API key value provided as a character scalar

    -
    service
    +
    service

    Service name, a character scalar.

    -
    username
    +
    username

    Username, a character scalar, or NULL if the key is not associated with a username.

    -
    keyring
    +
    keyring

    For systems that support multiple keyrings, specify the name of the keyring to use here. If NULL, then the default keyring is used. See also has_keyring_support().

    @@ -82,9 +84,7 @@

    Arguments

    Value

    - - -

    API Key value when called without key.

    +

    API Key value when called without key.

    Details

    @@ -103,7 +103,7 @@

    Details

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -118,15 +118,15 @@

    Author

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_directions.html b/reference/ors_directions.html index d9fc37b..061194b 100644 --- a/reference/ors_directions.html +++ b/reference/ors_directions.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -68,44 +68,42 @@

    Openrouteservice Directions

    Arguments

    -
    coordinates
    + + +
    coordinates

    List of longitude, latitude coordinate pairs visited in order, alternatively a two column matrix or data.frame.

    -
    profile
    +
    profile

    Route profile, defaults to "driving-car".

    -
    format
    +
    format

    Response format, defaults to "geojson"

    -
    ...
    +
    ...

    Optional parameters as described here

    -
    api_key
    +
    api_key

    Character scalar containing openrouteservice API key

    -
    output
    +
    output

    Output format. By default the response is being parsed to a list-based R object

    Value

    - - -

    Route between two or more locations in the selected format structured according to output:

    - - +

    Route between two or more locations in the selected format structured according to output:

    • for "text", a character vector of length 1 re-encoded to UTF-8.

    • for "parsed", a parsed R object.

    • for "sf", a simple features sf object.

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -171,26 +169,26 @@

    Examples

    #> .. .. .. .. .. .. ..$ name : chr "-" #> .. .. .. .. .. .. ..$ way_points : int [1:2] 85 96 #> .. .. .. .. .. .. [list output truncated] +#> .. .. ..$ way_points: int [1:2] 0 165 #> .. .. ..$ summary :List of 2 #> .. .. .. ..$ distance: num 5477 #> .. .. .. ..$ duration: num 804 -#> .. .. ..$ way_points: int [1:2] 0 165 #> .. ..$ geometry :List of 2 #> .. .. ..$ coordinates: num [1:166, 1:2] 8.34 8.34 8.34 8.34 8.34 ... #> .. .. ..$ type : chr "LineString" #> $ metadata:List of 6 #> ..$ attribution : chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ service : chr "routing" -#> ..$ timestamp : num 1.72e+12 +#> ..$ timestamp : num 1.73e+12 #> ..$ query :List of 4 #> .. ..$ coordinates: num [1:2, 1:2] 8.34 8.34 48.23 48.26 #> .. ..$ profile : chr "driving-car" #> .. ..$ preference : chr "fastest" #> .. ..$ format : chr "geojson" #> ..$ engine :List of 3 -#> .. ..$ version : chr "8.0.1" -#> .. ..$ build_date: chr "2024-05-14T10:47:52Z" -#> .. ..$ graph_date: chr "2024-05-22T15:20:03Z" +#> .. ..$ version : chr "8.1.3" +#> .. ..$ build_date: chr "2024-09-13T08:01:06Z" +#> .. ..$ graph_date: chr "2024-09-09T15:18:28Z" #> ..$ system_message: chr "Preference 'fastest' has been deprecated, using 'recommended'." # customized options @@ -256,26 +254,26 @@

    Examples

    #> .. .. .. .. .. .. [list output truncated] #> .. .. .. .. ..$ ascent : num 209 #> .. .. .. .. ..$ descent : num 231 +#> .. .. ..$ way_points: int [1:2] 0 153 #> .. .. ..$ summary :List of 2 #> .. .. .. ..$ distance: num 5206 #> .. .. .. ..$ duration: num 1272 -#> .. .. ..$ way_points: int [1:2] 0 153 #> .. ..$ geometry :List of 2 #> .. .. ..$ coordinates: num [1:154, 1:3] 8.34 8.34 8.34 8.34 8.34 ... #> .. .. ..$ type : chr "LineString" #> $ metadata:List of 5 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ service : chr "routing" -#> ..$ timestamp : num 1.72e+12 +#> ..$ timestamp : num 1.73e+12 #> ..$ query :List of 4 #> .. ..$ coordinates: num [1:2, 1:2] 8.34 8.34 48.23 48.26 #> .. ..$ profile : chr "cycling-mountain" #> .. ..$ format : chr "geojson" #> .. ..$ elevation : logi TRUE #> ..$ engine :List of 3 -#> .. ..$ version : chr "8.0.1" -#> .. ..$ build_date: chr "2024-05-14T10:47:52Z" -#> .. ..$ graph_date: chr "2024-05-16T15:51:47Z" +#> .. ..$ version : chr "8.1.3" +#> .. ..$ build_date: chr "2024-09-13T08:01:06Z" +#> .. ..$ graph_date: chr "2024-09-10T05:08:09Z" # list of locations as `data.frame` output as simple features `sf` object locations <- data.frame(lng = c(8.34234, 8.327807, 8.34423), @@ -283,8 +281,8 @@

    Examples

    ors_directions(locations, output = "sf") #> segments #> 1 2022.3, 308.9, 247.2, 59.3, 11, Head south on Benatweg, Benatweg, 0, 8, 51.8, 12.4, 6, Continue straight onto Benatweg, Benatweg, 8, 10, 820.5, 65.6, 1, Turn right onto Hölzle, K 5528, Hölzle, K 5528, 10, 34, 785.8, 151.6, 12, Keep left onto Winterbauernhof, Winterbauernhof, 34, 69, 49.1, 11.8, 4, Turn slight left, -, 69, 70, 67.9, 8.1, 1, Turn right, -, 70, 74, 0, 0, 10, Arrive at your destination, on the right, -, 74, 74, 4255.4, 739, 170.4, 20.5, 11, Head northwest, -, 74, 81, 448.5, 53.8, 13, Keep right, -, 81, 87, 317.2, 49.2, 0, Turn left, -, 87, 97, 44.3, 16, 1, Turn right onto Sulzbacher Straße, K 5528, Sulzbacher Straße, K 5528, 97, 101, 447.2, 82.5, 0, Turn left onto Sulzbacher Straße, Sulzbacher Straße, 101, 117, 434.6, 52.1, 0, Turn left, -, 117, 126, 248.1, 29.8, 13, Keep right, -, 126, 134, 286.6, 51.6, 1, Turn right, -, 134, 142, 257.5, 46.4, 12, Keep left, -, 142, 148, 357.9, 64.4, 13, Keep right, -, 148, 158, 12.1, 2.9, 6, Continue straight, -, 158, 159, 573.2, 112.1, 12, Keep left, -, 159, 175, 37.6, 9, 0, Turn left, -, 175, 177, 469.9, 112.8, 12, Keep left, -, 177, 191, 150.3, 36.1, 2, Turn sharp left, -, 191, 195, 0, 0, 10, Arrive at your destination, on the right, -, 195, 195 -#> summary way_points -#> 1 6277.7, 1047.9 0, 74, 195 +#> way_points summary +#> 1 0, 74, 195 6277.7, 1047.9 #> geometry #> 1 8.344268, 8.344147, 8.343946, 8.343854, 8.343320, 8.343098, 8.342861, 8.342712, 8.342328, 8.341843, 8.341711, 8.340515, 8.340359, 8.339942, 8.339417, 8.339260, 8.339220, 8.339223, 8.339411, 8.339409, 8.339355, 8.339251, 8.338979, 8.338824, 8.338489, 8.338386, 8.338316, 8.338226, 8.338175, 8.338114, 8.337902, 8.337249, 8.337061, 8.336708, 8.336131, 8.335783, 8.335414, 8.335074, 8.334962, 8.334932, 8.334891, 8.334806, 8.334515, 8.334384, 8.334146, 8.334041, 8.333953, 8.333861, 8.333611, 8.333482, 8.333392, 8.333340, 8.333317, 8.333328, 8.333436, 8.333446, 8.333404, 8.333292, 8.333145, 8.332979, 8.332862, 8.332688, 8.332346, 8.332214, 8.331826, 8.331389, 8.330941, 8.330020, 8.329920, 8.329540, 8.328893, 8.328703, 8.328396, 8.328169, 8.328164, 8.327920, 8.327493, 8.327338, 8.327158, 8.326912, 8.326497, 8.326373, 8.326280, 8.326231, 8.326236, 8.326308, 8.327059, 8.329405, 8.329279, 8.328513, 8.328162, 8.327693, 8.327464, 8.327160, 8.326899, 8.326721, 8.326660, 8.326656, 8.326768, 8.326886, 8.327037, 8.327209, 8.327158, 8.327161, 8.327185, 8.327239, 8.327322, 8.327442, 8.327574, 8.328226, 8.328796, 8.329184, 8.329717, 8.329955, 8.330110, 8.330285, 8.330782, 8.331267, 8.330564, 8.329241, 8.328986, 8.328760, 8.328565, 8.328351, 8.328113, 8.327991, 8.327836, 8.327728, 8.327725, 8.327751, 8.327941, 8.328014, 8.328076, 8.328105, 8.328209, 8.329228, 8.329634, 8.330093, 8.330368, 8.330683, 8.330780, 8.331074, 8.331145, 8.331525, 8.331698, 8.331776, 8.331790, 8.331733, 8.331604, 8.332141, 8.332452, 8.332688, 8.332678, 8.332716, 8.332766, 8.332833, 8.332992, 8.333628, 8.333871, 8.334020, 8.334761, 8.334941, 8.335546, 8.335655, 8.335753, 8.335783, 8.336230, 8.337095, 8.337525, 8.337830, 8.337898, 8.337994, 8.338356, 8.338735, 8.339091, 8.339439, 8.339605, 8.339754, 8.339960, 8.340984, 8.341287, 8.341604, 8.342297, 8.343026, 8.343188, 8.343387, 8.343800, 8.343999, 8.344228, 8.344626, 8.344987, 8.345244, 8.344067, 8.343897, 8.343478, 8.343434, 48.233826, 48.233507, 48.233136, 48.233047, 48.232736, 48.232474, 48.232308, 48.232240, 48.232159, 48.232035, 48.231953, 48.232359, 48.232428, 48.232808, 48.233214, 48.233466, 48.233591, 48.233716, 48.234339, 48.234482, 48.234602, 48.234725, 48.234928, 48.235017, 48.235174, 48.235261, 48.235374, 48.235773, 48.235892, 48.235965, 48.236121, 48.236511, 48.236666, 48.237071, 48.237768, 48.238040, 48.238277, 48.238614, 48.238903, 48.239111, 48.239218, 48.239282, 48.239431, 48.239520, 48.239788, 48.239877, 48.239909, 48.239921, 48.239899, 48.239861, 48.239830, 48.239843, 48.239894, 48.239999, 48.240348, 48.240520, 48.240610, 48.240688, 48.240735, 48.240733, 48.240701, 48.240594, 48.240159, 48.240071, 48.239922, 48.239790, 48.239676, 48.239262, 48.239242, 48.239282, 48.239183, 48.239291, 48.239412, 48.239533, 48.239537, 48.239765, 48.240034, 48.240109, 48.240167, 48.240221, 48.240340, 48.240413, 48.240542, 48.240653, 48.240784, 48.240900, 48.241600, 48.243751, 48.243950, 48.244376, 48.244574, 48.244856, 48.245012, 48.245358, 48.245553, 48.245716, 48.245828, 48.245872, 48.245903, 48.245936, 48.245996, 48.246012, 48.246275, 48.246468, 48.246573, 48.246687, 48.246774, 48.246841, 48.246879, 48.247012, 48.247227, 48.247339, 48.247518, 48.247633, 48.247749, 48.247912, 48.248171, 48.248544, 48.248910, 48.249508, 48.249649, 48.249815, 48.250022, 48.250340, 48.250731, 48.251026, 48.251499, 48.251938, 48.252047, 48.252163, 48.252560, 48.252757, 48.253089, 48.253425, 48.253685, 48.253911, 48.254049, 48.254158, 48.254306, 48.254523, 48.254627, 48.255072, 48.255147, 48.255442, 48.255713, 48.255939, 48.256163, 48.256782, 48.257332, 48.257903, 48.258317, 48.258782, 48.259292, 48.259438, 48.259503, 48.259567, 48.259649, 48.259820, 48.259922, 48.259967, 48.260235, 48.260331, 48.260712, 48.260829, 48.260994, 48.261319, 48.261624, 48.261892, 48.262004, 48.262411, 48.262441, 48.262434, 48.262321, 48.262012, 48.261771, 48.261581, 48.261778, 48.261830, 48.262052, 48.262661, 48.262828, 48.262945, 48.263073, 48.263176, 48.263176, 48.263132, 48.262990, 48.262970, 48.263014, 48.263142, 48.263166, 48.263242, 48.263207, 48.263233, 48.263529, 48.263552
    @@ -301,15 +299,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_elevation.html b/reference/ors_elevation.html index 3ccd4d8..d0a7033 100644 --- a/reference/ors_elevation.html +++ b/reference/ors_elevation.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -68,37 +68,35 @@

    Openrouteservice Elevation

    Arguments

    -
    format_in
    + + +
    format_in

    input format

    -
    geometry
    +
    geometry

    longitude, latitude coordinate pairs

    -
    format_out
    +
    format_out

    output format

    -
    ...
    +
    ...

    Optional parameters as described here

    -
    api_key
    +
    api_key

    Character scalar containing openrouteservice API key

    -
    output
    +
    output

    Output format. By default the response is being parsed to a list-based R object

    Value

    - - -

    3D point or line geometry structured according to output:

    - - +

    3D point or line geometry structured according to output:

    • for "text", a character vector of length 1 re-encoded to UTF-8.

    • for "parsed", a parsed R object.

    • for "sf", a simple features sf object.

    • @@ -110,7 +108,7 @@

      Details

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -153,15 +151,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_geocode.html b/reference/ors_geocode.html index a427e65..151740c 100644 --- a/reference/ors_geocode.html +++ b/reference/ors_geocode.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -67,32 +67,32 @@

    Openrouteservice Geocoding

    Arguments

    -
    query
    + + +
    query

    Name of location, street address or postal code. For a structured geocoding request a named list of parameters.

    -
    location
    +
    location

    Coordinates to be inquired provided in the form c(longitude, latitude)

    -
    ...
    +
    ...

    Optional parameters as described here

    -
    api_key
    +
    api_key

    Character scalar containing openrouteservice API key

    -
    output
    +
    output

    Output format. By default the response is being parsed to a list-based R object

    Value

    - - -

    Geocoding: a JSON formatted list of objects corresponding to the +

    Geocoding: a JSON formatted list of objects corresponding to the search input. Reverse geocoding: the next enclosing object with an address tag which surrounds the given coordinate.

    @@ -105,7 +105,7 @@

    Details

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -143,7 +143,7 @@

    Examples

    #> .. ..$ name : chr "Pelias" #> .. ..$ author : chr "Mapzen" #> .. ..$ version: chr "1.0" -#> ..$ timestamp : num 1.72e+12 +#> ..$ timestamp : num 1.73e+12 #> $ type : chr "FeatureCollection" #> $ features :List of 4 #> ..$ :List of 4 @@ -225,15 +225,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_isochrones.html b/reference/ors_isochrones.html index 68aaf6d..af95305 100644 --- a/reference/ors_isochrones.html +++ b/reference/ors_isochrones.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -68,39 +68,37 @@

    Openrouteservice Isochrones

    Arguments

    -
    locations
    + + +
    locations

    List of longitude, latitude coordinate pairs, alternatively a two column matrix or data.frame.

    -
    profile
    +
    profile

    Route profile, defaults to "driving-car".

    -
    range
    +
    range

    Maximum range value of the analysis in seconds for time and meters for distance. Alternatively a comma separated list of specific single range values.

    -
    ...
    +
    ...

    Optional parameters as described here

    -
    api_key
    +
    api_key

    Character scalar containing openrouteservice API key

    -
    output
    +
    output

    Output format. By default the response is being parsed to a list-based R object

    Value

    - - -

    A GeoJSON object containing a FeatureCollection of Polygons

    - - +

    A GeoJSON object containing a FeatureCollection of Polygons

    • for "text", a character vector of length 1 re-encoded to UTF-8.

    • for "parsed", a parsed R object.

    • for "sf", a simple features sf object.

    • @@ -113,7 +111,7 @@

      Details

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -178,7 +176,7 @@

    Examples

    #> $ metadata:List of 5 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ service : chr "isochrones" -#> ..$ timestamp : num 1.72e+12 +#> ..$ timestamp : num 1.73e+12 #> ..$ query :List of 4 #> .. ..$ profile : chr "driving-car" #> .. ..$ locations:List of 1 @@ -186,9 +184,9 @@

    Examples

    #> .. ..$ range : num 60 #> .. ..$ interval : num 20 #> ..$ engine :List of 3 -#> .. ..$ version : chr "8.0.1" -#> .. ..$ build_date: chr "2024-05-14T10:47:52Z" -#> .. ..$ graph_date: chr "2024-05-22T15:20:03Z" +#> .. ..$ version : chr "8.1.3" +#> .. ..$ build_date: chr "2024-09-13T08:01:06Z" +#> .. ..$ graph_date: chr "2024-09-09T15:18:28Z" locations <- list(c(8.681495, 49.41461), c(8.686507,49.41943)) ors_isochrones(locations, range=c(300, 200)) @@ -207,7 +205,7 @@

    Examples

    #> .. .. ..$ coordinates:List of 1 #> .. .. .. ..$ :List of 23 #> .. .. .. .. ..$ : num [1:2] 8.67 49.42 -#> .. .. .. .. ..$ : num [1:2] 8.67 49.42 +#> .. .. .. .. ..$ : num [1:2] 8.67 49.41 #> .. .. .. .. ..$ : num [1:2] 8.67 49.41 #> .. .. .. .. ..$ : num [1:2] 8.68 49.41 #> .. .. .. .. ..$ : num [1:2] 8.68 49.41 @@ -239,7 +237,7 @@

    Examples

    #> .. .. ..$ center : num [1:2] 8.69 49.42 #> .. ..$ geometry :List of 2 #> .. .. ..$ coordinates:List of 1 -#> .. .. .. ..$ :List of 21 +#> .. .. .. ..$ :List of 20 #> .. .. .. .. ..$ : num [1:2] 8.68 49.42 #> .. .. .. .. ..$ : num [1:2] 8.68 49.42 #> .. .. .. .. ..$ : num [1:2] 8.68 49.42 @@ -258,17 +256,17 @@

    Examples

    #> .. .. ..$ coordinates:List of 1 #> .. .. .. ..$ :List of 31 #> .. .. .. .. ..$ : num [1:2] 8.67 49.42 +#> .. .. .. .. ..$ : num [1:2] 8.67 49.42 #> .. .. .. .. ..$ : num [1:2] 8.67 49.41 #> .. .. .. .. ..$ : num [1:2] 8.68 49.41 #> .. .. .. .. ..$ : num [1:2] 8.68 49.41 #> .. .. .. .. ..$ : num [1:2] 8.68 49.41 -#> .. .. .. .. ..$ : num [1:2] 8.69 49.41 #> .. .. .. .. .. [list output truncated] #> .. .. ..$ type : chr "Polygon" #> $ metadata:List of 5 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ service : chr "isochrones" -#> ..$ timestamp : num 1.72e+12 +#> ..$ timestamp : num 1.73e+12 #> ..$ query :List of 3 #> .. ..$ profile : chr "driving-car" #> .. ..$ locations:List of 2 @@ -276,9 +274,9 @@

    Examples

    #> .. .. ..$ : num [1:2] 8.69 49.42 #> .. ..$ range : num [1:2] 300 200 #> ..$ engine :List of 3 -#> .. ..$ version : chr "8.0.1" -#> .. ..$ build_date: chr "2024-05-14T10:47:52Z" -#> .. ..$ graph_date: chr "2024-05-22T15:20:03Z" +#> .. ..$ version : chr "8.1.3" +#> .. ..$ build_date: chr "2024-09-13T08:01:06Z" +#> .. ..$ graph_date: chr "2024-09-09T15:18:28Z"
    @@ -293,15 +291,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_matrix.html b/reference/ors_matrix.html index bfd56fc..0da2189 100644 --- a/reference/ors_matrix.html +++ b/reference/ors_matrix.html @@ -4,7 +4,7 @@ - +
    @@ -35,20 +35,20 @@
    - +
    @@ -69,39 +69,37 @@

    Openrouteservice Matrix

    Arguments

    -
    locations
    + + +
    locations

    List of longitude, latitude coordinate pairs, alternatively a two column matrix or data.frame.

    -
    profile
    +
    profile

    Route profile, defaults to "driving-car".

    -
    ...
    +
    ...

    Optional parameters as described here

    -
    api_key
    +
    api_key

    Character scalar containing openrouteservice API key

    -
    output
    +
    output

    Output format. By default the response is being parsed to a list-based R object

    Value

    - - -

    Duration or distance matrix for multiple source and destination

    - - +

    Duration or distance matrix for multiple source and destination

    • for "text", a character vector of length 1 re-encoded to UTF-8.

    • for "parsed", a parsed R object.

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -119,18 +117,18 @@

    Examples

    # duration in hours res$durations / 3600 #> [,1] [,2] [,3] [,4] -#> [1,] 0.000000 1.588661 25.43788 109.66326 -#> [2,] 1.573725 0.000000 25.35500 109.58038 -#> [3,] 25.378472 25.215706 0.00000 84.68855 -#> [4,] 109.589428 109.426658 84.60273 0.00000 +#> [1,] 0.000000 1.588661 25.34786 109.59660 +#> [2,] 1.574931 0.000000 25.26587 109.51460 +#> [3,] 25.255472 25.112483 0.00000 84.71718 +#> [4,] 109.501136 109.358150 84.64148 0.00000 # distance in km res$distances #> [,1] [,2] [,3] [,4] -#> [1,] 0.00 153.50 2411.94 9779.03 -#> [2,] 153.81 0.00 2386.36 9753.45 -#> [3,] 2360.67 2336.52 0.00 7328.35 -#> [4,] 9713.04 9688.88 7312.74 0.00 +#> [1,] 0.00 153.50 2413.02 9780.14 +#> [2,] 153.80 0.00 2387.43 9754.55 +#> [3,] 2361.93 2337.78 0.00 7328.38 +#> [4,] 9714.39 9690.24 7312.85 0.00
    @@ -145,15 +143,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_optimization.html b/reference/ors_optimization.html index 46a2471..42b296d 100644 --- a/reference/ors_optimization.html +++ b/reference/ors_optimization.html @@ -8,7 +8,7 @@ - +
    @@ -39,20 +39,20 @@
    - +
    @@ -101,106 +101,104 @@

    Openrouteservice Optimization

    Arguments

    -
    jobs
    + + +
    jobs

    data.frame describing the places to visit

    -
    vehicles
    +
    vehicles

    data.frame describing the available vehicles

    -
    matrix
    +
    matrix

    Optional two-dimensional array describing a custom travel-time matrix

    -
    ...
    +
    ...

    Optional parameters as described here

    -
    api_key
    +
    api_key

    Character scalar containing openrouteservice API key

    -
    output
    +
    output

    Output format. By default the response is being parsed to a list-based R object

    -
    id
    +
    id

    An integer used as unique identifier

    -
    location
    +
    location

    Coordinates array

    -
    location_index
    +
    location_index

    Index of relevant row and column in custom matrix

    -
    service
    +
    service

    Job service duration (defaults to 0)

    -
    amount
    +
    amount

    An array of integers describing multidimensional quantities

    -
    skills
    +
    skills

    An array of integers defining skills

    -
    priority
    +
    priority

    An integer in the [0, 10] range describing priority level (defaults to 0)

    -
    time_windows
    +
    time_windows

    An array of time_window objects describing valid slots for job service start

    -
    profile
    +
    profile

    routing profile (defaults to car)

    -
    start
    +
    start

    coordinates array

    -
    start_index
    +
    start_index

    index of relevant row and column in custom matrix

    -
    end
    +
    end

    coordinates array

    -
    end_index
    +
    end_index

    index of relevant row and column in custom matrix

    -
    capacity
    +
    capacity

    an array of integers describing multidimensional quantities

    -
    time_window
    +
    time_window

    a time_window object describing working hours

    Value

    - - -

    Solution computed by the optimization endpoint formatted as described here and structured according to output:

    - - +

    Solution computed by the optimization endpoint formatted as described here and structured according to output:

    • for "text", a character vector of length 1 re-encoded to UTF-8.

    • for "parsed", a parsed R object.

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -239,7 +237,7 @@

    Examples

    #> List of 4 #> $ code : int 0 #> $ summary :List of 13 -#> ..$ cost : int 20659 +#> ..$ cost : int 20526 #> ..$ routes : int 2 #> ..$ unassigned : int 0 #> ..$ delivery : int 6 @@ -250,7 +248,7 @@

    Examples

    #> $ routes :List of 2 #> ..$ :List of 12 #> .. ..$ vehicle : int 1 -#> .. ..$ cost : int 7798 +#> .. ..$ cost : int 7726 #> .. ..$ delivery : int 3 #> .. ..$ amount : int 3 #> .. ..$ pickup : int 0 @@ -258,7 +256,7 @@

    Examples

    #> .. .. [list output truncated] #> ..$ :List of 12 #> .. ..$ vehicle : int 2 -#> .. ..$ cost : int 12861 +#> .. ..$ cost : int 12800 #> .. ..$ delivery : int 3 #> .. ..$ amount : int 3 #> .. ..$ pickup : int 0 @@ -278,15 +276,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_pois.html b/reference/ors_pois.html index 04bae17..8aa3c99 100644 --- a/reference/ors_pois.html +++ b/reference/ors_pois.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -67,35 +67,33 @@

    Openrouteservice POIs

    Arguments

    -
    request
    + + +
    request

    One of the following: "pois", "stats" or "list"

    -
    geometry
    +
    geometry

    named list containing either a geojson geometry object (GeoJSON Point, LineString or Polygon) or a bbox, optionally buffered by a value provided buffer

    -
    ...
    +
    ...

    Optional request attributes as described here

    -
    api_key
    +
    api_key

    Character scalar containing openrouteservice API key

    -
    output
    +
    output

    Output format. By default the response is being parsed to a list-based R object

    Value

    - - -

    A list of points of interest in the area specified in geometry structured according to output:

    - - +

    A list of points of interest in the area specified in geometry structured according to output:

    • for "text", a character vector of length 1 re-encoded to UTF-8.

    • for "parsed", a parsed R object.

    @@ -110,7 +108,7 @@

    Details

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -303,7 +301,7 @@

    Examples

    #> $ information:List of 4 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ version : chr "0.1" -#> ..$ timestamp : int 1716585701 +#> ..$ timestamp : int 1726651584 #> ..$ query :List of 2 #> .. ..$ request : chr "pois" #> .. ..$ geometry:List of 2 @@ -428,7 +426,7 @@

    Examples

    #> $ information:List of 4 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ version : chr "0.1" -#> ..$ timestamp : int 1716585702 +#> ..$ timestamp : int 1726651585 #> ..$ query :List of 2 #> .. ..$ request : chr "pois" #> .. ..$ geometry:List of 2 @@ -533,7 +531,7 @@

    Examples

    #> $ information:List of 4 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ version : chr "0.1" -#> ..$ timestamp : int 1716585702 +#> ..$ timestamp : int 1726651585 #> ..$ query :List of 5 #> .. ..$ request : chr "pois" #> .. ..$ limit : int 200 @@ -640,7 +638,7 @@

    Examples

    #> $ information:List of 4 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ version : chr "0.1" -#> ..$ timestamp : int 1716585702 +#> ..$ timestamp : int 1726651585 #> ..$ query :List of 5 #> .. ..$ request : chr "pois" #> .. ..$ limit : int 200 @@ -707,7 +705,7 @@

    Examples

    #> $ information:List of 4 #> ..$ attribution: chr "openrouteservice.org | OpenStreetMap contributors" #> ..$ version : chr "0.1" -#> ..$ timestamp : int 1716585702 +#> ..$ timestamp : int 1726651585 #> ..$ query :List of 2 #> .. ..$ request : chr "stats" #> .. ..$ geometry:List of 2 @@ -729,15 +727,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_profile.html b/reference/ors_profile.html index 268c63b..b3acca8 100644 --- a/reference/ors_profile.html +++ b/reference/ors_profile.html @@ -3,7 +3,7 @@ - +
    @@ -34,20 +34,20 @@
    - +
    @@ -64,15 +64,15 @@

    Openrouteservice Profiles

    Arguments

    -
    mode
    + + +
    mode

    Profile label.

    Value

    - - -

    Profile name, or named vector of available profiles.

    +

    Profile name, or named vector of available profiles.

    Details

    @@ -85,7 +85,7 @@

    See also

    Author

    -

    Andrzej Oleś andrzej@openrouteservice.org

    +

    Andrzej Oleś andrzej.oles@gmail.com

    @@ -116,15 +116,15 @@

    Examples

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/reference/ors_snap.html b/reference/ors_snap.html new file mode 100644 index 0000000..aabc66a --- /dev/null +++ b/reference/ors_snap.html @@ -0,0 +1,149 @@ + +Openrouteservice Snapping — ors_snap • openrouteservice + + +
    +
    + + + +
    +
    + + +
    +

    Snap coordinates to road network

    +
    + +
    +
    ors_snap(
    +  locations,
    +  profile = ors_profile(),
    +  radius,
    +  format = c("geojson", "json"),
    +  ...,
    +  api_key = ors_api_key(),
    +  output = c("parsed", "text")
    +)
    +
    + +
    +

    Arguments

    + + +
    locations
    +

    List of longitude, latitude coordinate pairs, alternatively a two column matrix or data.frame.

    + + +
    profile
    +

    Route profile, defaults to "driving-car".

    + + +
    radius
    +

    Maximum radius in meters around given coordinates to search for graph edges

    + + +
    format
    +

    Response format, defaults to "geojson"

    + + +
    ...
    +

    Optional parameters as described here

    + + +
    api_key
    +

    Character scalar containing openrouteservice API key

    + + +
    output
    +

    Output format. By default the response is being parsed to a list-based R object

    + +
    +
    +

    Value

    +

    Coordinates of snapped location(s) and distance to the original point(s) structured according to output:

    +
    • for "text", a character vector of length 1 re-encoded to UTF-8.

    • +
    • for "parsed", a parsed R object.

    • +
    +
    +

    Author

    +

    Andrzej Oleś andrzej.oles@gmail.com

    +
    + +
    +

    Examples

    +
    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)
    +
    +
    +
    +
    + +
    + + +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/print.ors_api.html b/reference/print.ors_api.html index 0d99b38..006c050 100644 --- a/reference/print.ors_api.html +++ b/reference/print.ors_api.html @@ -4,7 +4,7 @@ - +
    @@ -35,20 +35,20 @@
    - +
    @@ -58,35 +58,35 @@

    Print a Compact Summary of the API Response

    -
    # S3 method for ors_api
    +    
    # S3 method for class 'ors_api'
     print(x, give.attr = FALSE, list.len = 6L, ...)

    Arguments

    -
    x
    + + +
    x

    object of class ors_api.

    -
    give.attr
    +
    give.attr

    logical; if TRUE (default), show attributes as sub structures.

    -
    list.len
    +
    list.len

    numeric; maximum number of list elements to display within a level.

    -
    ...
    +
    ...

    further arguments passed to str.

    Value

    - - -

    print.ors_api prints its argument and returns it invisibly.

    +

    print.ors_api prints its argument and returns it invisibly.

    @@ -101,15 +101,15 @@

    Value

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/sitemap.xml b/sitemap.xml index 6127f99..66179db 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1,60 +1,23 @@ - - - - /404.html - - - /LICENSE-text.html - - - /articles/index.html - - - /articles/openrouteservice.html - - - /authors.html - - - /index.html - - - /news/index.html - - - /reference/fitBBox.html - - - /reference/index.html - - - /reference/ors_api_key.html - - - /reference/ors_directions.html - - - /reference/ors_elevation.html - - - /reference/ors_geocode.html - - - /reference/ors_isochrones.html - - - /reference/ors_matrix.html - - - /reference/ors_optimization.html - - - /reference/ors_pois.html - - - /reference/ors_profile.html - - - /reference/print.ors_api.html - + +/404.html +/LICENSE-text.html +/articles/index.html +/articles/openrouteservice.html +/authors.html +/index.html +/news/index.html +/reference/fitBBox.html +/reference/index.html +/reference/ors_api_key.html +/reference/ors_directions.html +/reference/ors_elevation.html +/reference/ors_geocode.html +/reference/ors_isochrones.html +/reference/ors_matrix.html +/reference/ors_optimization.html +/reference/ors_pois.html +/reference/ors_profile.html +/reference/ors_snap.html +/reference/print.ors_api.html +