R/directions_api.R
In location-iq/locationiq-r-client: R Package Client for LocationIQ
# LocationIQ
#
# LocationIQ provides flexible enterprise-grade location based solutions. We work with developers, startups and enterprises worldwide serving billions of requests everyday. This page provides an overview of the technical aspects of our API and will help you get started.
#
# The version of the OpenAPI document: 1.1.0
#
# Generated by: https://openapi-generator.tech
#' @docType class
#' @title Directions operations
#' @description locationiq.Directions
#' @format An \code{R6Class} generator object
#' @field apiClient Handles the client-server communication.
#'
#' @section Methods:
#' \describe{
#' \strong{ Directions } \emph{ Directions Service }
#' Finds the fastest route between coordinates in the supplied order.
#'
#' \itemize{
#' \item \emph{ @param } coordinates character
#' \item \emph{ @param } bearings character
#' \item \emph{ @param } radiuses character
#' \item \emph{ @param } generate.hints character
#' \item \emph{ @param } approaches character
#' \item \emph{ @param } exclude character
#' \item \emph{ @param } alternatives numeric
#' \item \emph{ @param } steps character
#' \item \emph{ @param } annotations character
#' \item \emph{ @param } geometries character
#' \item \emph{ @param } overview character
#' \item \emph{ @param } continue.straight character
#' \item \emph{ @returnType } \link{DirectionsDirections} \cr
#'
#'
#' \item status code : 200 | OK
#'
#' \item return type : DirectionsDirections
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 400 | Bad Request
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 401 | Unauthorized
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 403 | The request has been made from an unauthorized domain.
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 404 | No location or places were found for the given input
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 429 | Request exceeded the rate-limits set on your account
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 500 | Internal Server Error
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' }
#'
#' }
#'
#'
#' @examples
#' \donttest{
#' #################### Directions ####################
#'
#' library(locationiq)
#' var.coordinates <- '-0.16102,51.523854;-0.15797,51.52326;-0.161593,51.522550' # character | String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}). polyline follows Google's polyline format with precision 5
#' var.bearings <- '10,20;40,30;30,9' # character | Limits the search to segments with given bearing in degrees towards true north in clockwise direction. List of positive integer pairs separated by semi-colon and bearings array should be equal to length of coordinate array. Input Value :- {bearing};{bearing}[;{bearing} ...] Bearing follows the following format : bearing {value},{range} integer 0 .. 360,integer 0 .. 180
#' var.radiuses <- '500;200;300' # character | Limits the search to given radius in meters Radiuses array length should be same as coordinates array, eaach value separated by semi-colon. Input Value - {radius};{radius}[;{radius} ...] Radius has following format :- double >= 0 or unlimited (default)
#' var.generate.hints <- 'false' # character | Adds a Hint to the response which can be used in subsequent requests, see hints parameter. Input Value - true (default), false Format - Base64 String
#' var.approaches <- 'curb;curb;curb' # character | Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default)
#' var.exclude <- 'toll' # character | Additive list of classes to avoid, order does not matter. input Value - {class}[,{class}] Format - A class name determined by the profile or none.
#' var.alternatives <- 0 # numeric | Search for alternative routes. Passing a number alternatives=n searches for up to n alternative routes. [ true, false (default), or Number ]
#' var.steps <- 'true' # character | Returned route steps for each route leg [ true, false (default) ]
#' var.annotations <- 'false' # character | Returns additional metadata for each coordinate along the route geometry. [ true, false (default), nodes, distance, duration, datasources, weight, speed ]
#' var.geometries <- 'polyline' # character | Returned route geometry format (influences overview and per step) [ polyline (default), polyline6, geojson ]
#' var.overview <- 'simplified' # character | Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. [ simplified (default), full, false ]
#' var.continue.straight <- 'default' # character | Forces the route to keep going straight at waypoints constraining uturns there even if it would be faster. Default value depends on the profile [ default (default), true, false ]
#'
#' #Directions Service
#' api.instance <- DirectionsApi$new()
#'
#' #Configure API key authorization: key
#' api.instance$apiClient$apiKeys['key'] <- 'TODO_YOUR_API_KEY';
#'
#' result <- api.instance$Directions(var.coordinates, bearings=var.bearings, radiuses=var.radiuses, generate.hints=var.generate.hints, approaches=var.approaches, exclude=var.exclude, alternatives=var.alternatives, steps=var.steps, annotations=var.annotations, geometries=var.geometries, overview=var.overview, continue.straight=var.continue.straight)
#'
#'
#' }
#' @importFrom R6 R6Class
#' @importFrom caTools base64encode
#' @export
DirectionsApi <- R6::R6Class(
'DirectionsApi',
public = list(
apiClient = NULL,
initialize = function(apiClient){
if (!missing(apiClient)) {
self$apiClient <- apiClient
}
else {
self$apiClient <- ApiClient$new()
}
},
Directions = function(coordinates, bearings=NULL, radiuses=NULL, generate.hints=NULL, approaches=NULL, exclude=NULL, alternatives=NULL, steps=NULL, annotations='"false"', geometries='"polyline"', overview='"simplified"', continue.straight='"default"', ...){
apiResponse <- self$DirectionsWithHttpInfo(coordinates, bearings, radiuses, generate.hints, approaches, exclude, alternatives, steps, annotations, geometries, overview, continue.straight, ...)
resp <- apiResponse$response
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
apiResponse$content
} else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) {
apiResponse
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
apiResponse
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
apiResponse
}
},
DirectionsWithHttpInfo = function(coordinates, bearings=NULL, radiuses=NULL, generate.hints=NULL, approaches=NULL, exclude=NULL, alternatives=NULL, steps=NULL, annotations='"false"', geometries='"polyline"', overview='"simplified"', continue.straight='"default"', ...){
args <- list(...)
queryParams <- list()
headerParams <- c()
if (missing(`coordinates`)) {
stop("Missing required parameter `coordinates`.")
}
queryParams['bearings'] <- bearings
queryParams['radiuses'] <- radiuses
queryParams['generate_hints'] <- generate.hints
queryParams['approaches'] <- approaches
queryParams['exclude'] <- exclude
queryParams['alternatives'] <- alternatives
queryParams['steps'] <- steps
queryParams['annotations'] <- annotations
queryParams['geometries'] <- geometries
queryParams['overview'] <- overview
queryParams['continue_straight'] <- continue.straight
urlPath <- "/directions/driving/{coordinates}"
if (!missing(`coordinates`)) {
urlPath <- gsub(paste0("\\{", "coordinates", "\\}"), URLencode(as.character(`coordinates`), reserved = TRUE), urlPath)
}
# API key authentication
if ("key" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["key"]) > 0) {
queryParams['key'] <- paste(unlist(self$apiClient$apiKeys["key"]), collapse='')
}
resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
deserializedRespObj <- tryCatch(
self$apiClient$deserialize(resp, "DirectionsDirections", loadNamespace("locationiq")),
error = function(e){
stop("Failed to deserialize response")
}
)
ApiResponse$new(deserializedRespObj, resp)
} else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) {
ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp)
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
ApiResponse$new("API client error", resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
ApiResponse$new("API server error", resp)
}
}
)
)
location-iq/locationiq-r-client documentation built on Feb. 28, 2020, 9:42 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
# LocationIQ
#
# LocationIQ provides flexible enterprise-grade location based solutions. We work with developers, startups and enterprises worldwide serving billions of requests everyday. This page provides an overview of the technical aspects of our API and will help you get started.
#
# The version of the OpenAPI document: 1.1.0
#
# Generated by: https://openapi-generator.tech
#' @docType class
#' @title Directions operations
#' @description locationiq.Directions
#' @format An \code{R6Class} generator object
#' @field apiClient Handles the client-server communication.
#'
#' @section Methods:
#' \describe{
#' \strong{ Directions } \emph{ Directions Service }
#' Finds the fastest route between coordinates in the supplied order.
#'
#' \itemize{
#' \item \emph{ @param } coordinates character
#' \item \emph{ @param } bearings character
#' \item \emph{ @param } radiuses character
#' \item \emph{ @param } generate.hints character
#' \item \emph{ @param } approaches character
#' \item \emph{ @param } exclude character
#' \item \emph{ @param } alternatives numeric
#' \item \emph{ @param } steps character
#' \item \emph{ @param } annotations character
#' \item \emph{ @param } geometries character
#' \item \emph{ @param } overview character
#' \item \emph{ @param } continue.straight character
#' \item \emph{ @returnType } \link{DirectionsDirections} \cr
#'
#'
#' \item status code : 200 | OK
#'
#' \item return type : DirectionsDirections
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 400 | Bad Request
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 401 | Unauthorized
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 403 | The request has been made from an unauthorized domain.
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 404 | No location or places were found for the given input
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 429 | Request exceeded the rate-limits set on your account
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' \item status code : 500 | Internal Server Error
#'
#' \item return type : Error
#' \item response headers :
#'
#' \tabular{ll}{
#' }
#' }
#'
#' }
#'
#'
#' @examples
#' \donttest{
#' #################### Directions ####################
#'
#' library(locationiq)
#' var.coordinates <- '-0.16102,51.523854;-0.15797,51.52326;-0.161593,51.522550' # character | String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}). polyline follows Google's polyline format with precision 5
#' var.bearings <- '10,20;40,30;30,9' # character | Limits the search to segments with given bearing in degrees towards true north in clockwise direction. List of positive integer pairs separated by semi-colon and bearings array should be equal to length of coordinate array. Input Value :- {bearing};{bearing}[;{bearing} ...] Bearing follows the following format : bearing {value},{range} integer 0 .. 360,integer 0 .. 180
#' var.radiuses <- '500;200;300' # character | Limits the search to given radius in meters Radiuses array length should be same as coordinates array, eaach value separated by semi-colon. Input Value - {radius};{radius}[;{radius} ...] Radius has following format :- double >= 0 or unlimited (default)
#' var.generate.hints <- 'false' # character | Adds a Hint to the response which can be used in subsequent requests, see hints parameter. Input Value - true (default), false Format - Base64 String
#' var.approaches <- 'curb;curb;curb' # character | Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default)
#' var.exclude <- 'toll' # character | Additive list of classes to avoid, order does not matter. input Value - {class}[,{class}] Format - A class name determined by the profile or none.
#' var.alternatives <- 0 # numeric | Search for alternative routes. Passing a number alternatives=n searches for up to n alternative routes. [ true, false (default), or Number ]
#' var.steps <- 'true' # character | Returned route steps for each route leg [ true, false (default) ]
#' var.annotations <- 'false' # character | Returns additional metadata for each coordinate along the route geometry. [ true, false (default), nodes, distance, duration, datasources, weight, speed ]
#' var.geometries <- 'polyline' # character | Returned route geometry format (influences overview and per step) [ polyline (default), polyline6, geojson ]
#' var.overview <- 'simplified' # character | Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. [ simplified (default), full, false ]
#' var.continue.straight <- 'default' # character | Forces the route to keep going straight at waypoints constraining uturns there even if it would be faster. Default value depends on the profile [ default (default), true, false ]
#'
#' #Directions Service
#' api.instance <- DirectionsApi$new()
#'
#' #Configure API key authorization: key
#' api.instance$apiClient$apiKeys['key'] <- 'TODO_YOUR_API_KEY';
#'
#' result <- api.instance$Directions(var.coordinates, bearings=var.bearings, radiuses=var.radiuses, generate.hints=var.generate.hints, approaches=var.approaches, exclude=var.exclude, alternatives=var.alternatives, steps=var.steps, annotations=var.annotations, geometries=var.geometries, overview=var.overview, continue.straight=var.continue.straight)
#'
#'
#' }
#' @importFrom R6 R6Class
#' @importFrom caTools base64encode
#' @export
DirectionsApi <- R6::R6Class(
'DirectionsApi',
public = list(
apiClient = NULL,
initialize = function(apiClient){
if (!missing(apiClient)) {
self$apiClient <- apiClient
}
else {
self$apiClient <- ApiClient$new()
}
},
Directions = function(coordinates, bearings=NULL, radiuses=NULL, generate.hints=NULL, approaches=NULL, exclude=NULL, alternatives=NULL, steps=NULL, annotations='"false"', geometries='"polyline"', overview='"simplified"', continue.straight='"default"', ...){
apiResponse <- self$DirectionsWithHttpInfo(coordinates, bearings, radiuses, generate.hints, approaches, exclude, alternatives, steps, annotations, geometries, overview, continue.straight, ...)
resp <- apiResponse$response
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
apiResponse$content
} else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) {
apiResponse
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
apiResponse
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
apiResponse
}
},
DirectionsWithHttpInfo = function(coordinates, bearings=NULL, radiuses=NULL, generate.hints=NULL, approaches=NULL, exclude=NULL, alternatives=NULL, steps=NULL, annotations='"false"', geometries='"polyline"', overview='"simplified"', continue.straight='"default"', ...){
args <- list(...)
queryParams <- list()
headerParams <- c()
if (missing(`coordinates`)) {
stop("Missing required parameter `coordinates`.")
}
queryParams['bearings'] <- bearings
queryParams['radiuses'] <- radiuses
queryParams['generate_hints'] <- generate.hints
queryParams['approaches'] <- approaches
queryParams['exclude'] <- exclude
queryParams['alternatives'] <- alternatives
queryParams['steps'] <- steps
queryParams['annotations'] <- annotations
queryParams['geometries'] <- geometries
queryParams['overview'] <- overview
queryParams['continue_straight'] <- continue.straight
urlPath <- "/directions/driving/{coordinates}"
if (!missing(`coordinates`)) {
urlPath <- gsub(paste0("\\{", "coordinates", "\\}"), URLencode(as.character(`coordinates`), reserved = TRUE), urlPath)
}
# API key authentication
if ("key" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["key"]) > 0) {
queryParams['key'] <- paste(unlist(self$apiClient$apiKeys["key"]), collapse='')
}
resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
deserializedRespObj <- tryCatch(
self$apiClient$deserialize(resp, "DirectionsDirections", loadNamespace("locationiq")),
error = function(e){
stop("Failed to deserialize response")
}
)
ApiResponse$new(deserializedRespObj, resp)
} else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) {
ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp)
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
ApiResponse$new("API client error", resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
ApiResponse$new("API server error", resp)
}
}
)
)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.