osmdata_sf: Return an OSM Overpass query as an osmdata object in 'sf'...

In osmdatar/osmdata: Import 'OpenStreetMap' Data as Simple Features or Spatial Objects

Return an OSM Overpass query as an osmdata object in sf format.

Description

Return an OSM Overpass query as an osmdata object in sf format.

Usage

osmdata_sf(q, doc, quiet = TRUE, stringsAsFactors = FALSE)

Arguments

q	An object of class overpass_query constructed with opq and add_osm_feature or a string with a valid query, such as "(node(39.4712701,-0.3841326,39.4713799,-0.3839475);); out;". 39.4712701,-0.3841326,39.4713799,-0.3839475 May be be omitted, in which case the osmdata object will not include the query. See examples below.
doc	If missing, doc is obtained by issuing the overpass query, q, otherwise either the name of a file from which to read data, or an object of class xml2 returned from osmdata_xml.
quiet	suppress status messages.
stringsAsFactors	Should character strings in 'sf' 'data.frame' be coerced to factors?

Value

An object of class osmdata with the OSM components (points, lines, and polygons) represented in sf format.

Note

In 'dplyr'-type workflows in which the output of this function is piped to other functions, it will generally be necessary to explicitly load the sf package into the current workspace with 'library(sf)'.

See Also

Other extract: osmdata_data_frame(), osmdata_sc(), osmdata_sp(), osmdata_xml()

Examples

## Not run: 
query <- opq ("hampi india") |>
    add_osm_feature (key = "historic", value = "ruins")
# Then extract data from 'Overpass' API
hampi_sf <- osmdata_sf (query)

## End(Not run)

# Complex query as a string (not possible with regular osmdata functions)
q <- '[out:xml][timeout:50];
    area[name="Països Catalans"][boundary=political]->.boundaryarea;

    rel(area.boundaryarea)[admin_level=8][boundary=administrative];
    map_to_area -> .all_level_8_areas;

    ( nwr(area.boundaryarea)[amenity=townhall]; >; );
    is_in;
    area._[admin_level=8][boundary=administrative] -> .level_8_areas_with_townhall;

    (.all_level_8_areas; - .level_8_areas_with_townhall;);
    rel(pivot);
    (._; >;);
    out;'

## Not run: 
no_townhall <- osmdata_sf (q)
no_townhall

## End(Not run)

osmdatar/osmdata documentation built on July 4, 2025, 10:11 a.m.