ORS remote instance

Creates a new ORS instance object. This R6 class is typically constructed by ors_instance.

This object represents a remote instance, i.e. an existing server like the public API.

Super class

rors::ORSInstance -> ORSRemote

Public fields

url

URL to the ORS server

token

Information about API tokens

Methods

Public methods

• ORSRemote$new()

• ORSRemote$clone()

Inherited methods

• rors::ORSInstance$get_status()
• rors::ORSInstance$get_url()
• rors::ORSInstance$is_mounted()
• rors::ORSInstance$is_ready()

---

Method new()

Initialize the remote ORS instance.

Usage

ORSRemote$new(server, token = FALSE)

Arguments

server

[character]

URL of a server that accepts OpenRouteService requests. This can be a URL to a local or a remote server. The official public API can be accessed using the shortcuts "public" or "pub". Keep in mind that the public API is rate-restricted and requests are automatically throttled to 40 requests per minute. Routing functions will be slow for larger datasets.

token

[logical]

Whether server requires authorization over a token. ORS tokens are stored in the ORS_TOKEN environment variable. Defaults to FALSE. If server is the public API, token is set to TRUE.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ORSRemote$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.