Wraps osmdata
functions to query OSM data by adjusted bounding box or
by enclosing ways/relations around the center of a location. timeout and
nodes_only parameters are not fully supported currently.
Usage
get_osm_data(
location = NULL,
dist = NULL,
diag_ratio = NULL,
unit = NULL,
asp = NULL,
key,
value = NULL,
features = NULL,
crs = NULL,
geometry = NULL,
osmdata = FALSE,
enclosing = NULL,
nodes_only = FALSE,
timeout = 120
)
get_osm_id(id, type = NULL, crs = NULL, geometry = NULL, osmdata = FALSE)
get_osm_boundaries(
location,
level = NULL,
lang = "en",
crs = NULL,
enclosing = "relation",
geometry = NULL,
osmdata = FALSE
)
Arguments
- location
A
sf
,sfc
, orbbox
object.- dist
buffer distance in units. Optional.
- diag_ratio
ratio of diagonal distance of area's bounding box used as buffer distance. e.g. if the diagonal distance is 3000 meters and the "diag_ratio = 0.1" a 300 meter will be used. Ignored when
dist
is provided.- unit
Units for buffer. Supported options include "meter", "foot", "kilometer", and "mile", "nautical mile" Common abbreviations (e.g. "km" instead of "kilometer") are also supported. Distance in units is converted to units matching GDAL units for x; defaults to "meter"
- asp
Aspect ratio of width to height as a numeric value (e.g. 0.33) or character (e.g. "1:3"). If numeric,
get_asp()
returns the same value without modification.- key
Feature key for overpass API query.
- value
Value of the feature key; can be negated with an initial exclamation mark,
value = "!this"
, and can also be a vector,value = c("this", "that")
. Ifvalue = "all"
or ifkey = "building"
the values passed to the osmdata package are from a preset list extracted fromosmdata::available_tags()
.- features
Character vector of key-value pairs with keys and values enclosed in escape-formatted quotations (see examples).
- crs
Coordinate reference system for output data; if
NULL
, the data remains in the Open Street Map coordinate reference system 4326. Default:NULL
.- geometry
Geometry type to output ("polygons", "points", "lines", "multilines", or "multipolygons"); if multiple geometry types are needed set osmdata to
TRUE.
DefaultNULL
.- osmdata
If
TRUE
return aosmdata
class object that includes the overpass API call, metadata including timestamp and version numbers, and all available geometry types; defaults toFALSE
.- enclosing
If enclosing is "relation" or "way", use the
osmdata::opq_enclosing()
function to query the OSM data (instead ofosmdata::add_osm_feature()
. Defaults toNULL
. When using enclosing, the dist, diag_ratio, asp, and unit parameters are ignored and the center of the provided location is used for the query. geometry is set automatically based enclosing with "relation" using "multipolygon" and "way" using "polygon" geometry.- nodes_only
If
TRUE
, query OSM nodes only. Some OSM structures such asplace = "city"
orhighway = "traffic_signals"
are represented by nodes only. Queries are built by default to return all nodes, ways, and relation, but this can be very inefficient for node-only queries. Setting this value toTRUE
for such cases makes queries more efficient, with data returned in theosm_points
list item.- timeout
It may be necessary to increase this value for large queries, because the server may time out before all data are delivered.
- id
OpenStreetMap feature id
- type
type of feature with id; "node", "way", or "relation"
- level
administrative level (admin_level) of boundary to return; defaults to
NULL
. See https://wiki.openstreetmap.org/wiki/Key:admin_level for more information. Only used for get_osm_boundaries.- lang
Language for boundary names to include in resulting data frame (e.g. "en" for English or "es" for Spanish). Default language names should always be included in results. Defaults to "en". See https://wiki.openstreetmap.org/wiki/Multilingual_names for more information.