This function search amenities as defined by OpenStreetMap
on a restricted area defined by a bounding box in the form
(<xmin>, <ymin>, <xmax>, <ymax>)
. This function returns the
tibble
associated with the query, see geo_amenity_sf()
for retrieving the data as a spatial object (sf
format).
Usage
geo_amenity(
bbox,
amenity,
lat = "lat",
long = "lon",
limit = 1,
full_results = FALSE,
return_addresses = TRUE,
verbose = FALSE,
nominatim_server = "https://nominatim.openstreetmap.org/",
progressbar = TRUE,
custom_query = list(),
strict = FALSE
)
Arguments
- bbox
The bounding box (viewbox) used to limit the search. It could be:
- amenity
A
character
(or a vector ofcharacter
s) with the amenities to be geolocated (i.e.c("pub", "restaurant")
). See osm_amenities.- lat
Latitude column name in the output data (default
"lat"
).- long
Longitude column name in the output data (default
"long"
).- limit
Maximum number of results to return per input address. Note that each query returns a maximum of 50 results.
- full_results
Returns all available data from the API service. If
FALSE
(default) only latitude, longitude and address columns are returned. See alsoreturn_addresses
.- return_addresses
Return input addresses with results if
TRUE
.- verbose
If
TRUE
then detailed logs are output to the console.- nominatim_server
The URL of the Nominatim server to use. Defaults to
"https://nominatim.openstreetmap.org/"
.- progressbar
Logical. If
TRUE
displays a progress bar to indicate the progress of the function.- custom_query
A named list with API-specific parameters to be used (i.e.
list(countrycodes = "US")
). See Details.- strict
Logical
TRUE/FALSE
. Force the results to be included inside thebbox
. Note that Nominatim default behavior may return results located outside the provided bounding box.
Value
A tibble
with the results found by the query.
Details
Bounding boxes can be located using different online tools, as Bounding Box Tool.
For a full list of valid amenities see https://wiki.openstreetmap.org/wiki/Key:amenity and osm_amenities.
See https://nominatim.org/release-docs/latest/api/Search/ for additional
parameters to be passed to custom_query
.
See also
Other amenity:
geo_amenity_sf()
,
osm_amenities
Geocoding:
geo_address_lookup()
,
geo_address_lookup_sf()
,
geo_amenity_sf()
,
geo_lite()
,
geo_lite_sf()
,
geo_lite_struct()
,
geo_lite_struct_sf()
Examples
# \donttest{
# Times Square, NY, USA
bbox <- c(
-73.9894467311, 40.75573629,
-73.9830630737, 40.75789245
)
geo_amenity(
bbox = bbox,
amenity = "restaurant"
)
#> # A tibble: 1 × 4
#> query lat lon address
#> <chr> <dbl> <dbl> <chr>
#> 1 restaurant 40.8 -74.0 Amor Loco, 134, West 46th Street, Manhattan Community …
# Several amenities
geo_amenity(
bbox = bbox,
amenity = c("restaurant", "pub")
)
#>
|
| | 0%
|
|========================= | 50%
|
|==================================================| 100%
#> # A tibble: 2 × 4
#> query lat lon address
#> <chr> <dbl> <dbl> <chr>
#> 1 restaurant 40.8 -74.0 Amor Loco, 134, West 46th Street, Manhattan Community …
#> 2 pub 40.8 -74.0 Bar 54, West 44th Street, Manhattan Community Board 5,…
# Increase limit and use with strict
geo_amenity(
bbox = bbox,
amenity = c("restaurant", "pub"),
limit = 10,
strict = TRUE
)
#>
|
| | 0%
|
|========================= | 50%
|
|==================================================| 100%
#> # A tibble: 17 × 4
#> query lat lon address
#> <chr> <dbl> <dbl> <chr>
#> 1 restaurant 40.8 -74.0 Sardi's, 234, West 44th Street, Manhattan Community B…
#> 2 restaurant 40.8 -74.0 bella vita tranttoria, 211, West 43rd Street, Manhatt…
#> 3 restaurant 40.8 -74.0 Amor Loco, 134, West 46th Street, Manhattan Community…
#> 4 restaurant 40.8 -74.0 Planet Hollywood, 1540, Broadway, Manhattan Community…
#> 5 restaurant 40.8 -74.0 Haru Sushi, 229, West 43rd Street, Manhattan Communit…
#> 6 restaurant 40.8 -74.0 Brooklyn Deli, 1501, Broadway, Manhattan Community Bo…
#> 7 restaurant 40.8 -74.0 Hard Rock Cafe, 1501, Broadway, Manhattan Community B…
#> 8 restaurant 40.8 -74.0 Bubba Gump Shrimp Co., 1501, Broadway, Manhattan Comm…
#> 9 restaurant 40.8 -74.0 Carmine's, 200, West 44th Street, Manhattan Community…
#> 10 restaurant 40.8 -74.0 Guy’s American Kitchen & Bar, 220, West 44th Street, …
#> 11 pub 40.8 -74.0 Bar 54, West 44th Street, Manhattan Community Board 5…
#> 12 pub 40.8 -74.0 O'Donoghue's, 156, West 44th Street, Manhattan Commun…
#> 13 pub 40.8 -74.0 Connolly's, 121, West 45th Street, Manhattan Communit…
#> 14 pub 40.8 -74.0 Perfect Pint, 123, West 45th Street, Manhattan Commun…
#> 15 pub 40.8 -74.0 O'Lunney's, 145, West 45th Street, Manhattan Communit…
#> 16 pub 40.8 -74.0 Jimmy's Corner, 140, West 44th Street, Manhattan Comm…
#> 17 pub 40.8 -74.0 BXL Cafe, 125, West 43rd Street, Manhattan Community …
# }