geo_lite {nominatimlite} | R Documentation |
Address search API for OSM elements
Description
Geocodes addresses given as character values. This function returns the
tibble associated with the query, see geo_lite_sf()
for
retrieving the data as a spatial object (sf format).
Usage
geo_lite(
address,
lat = "lat",
long = "lon",
limit = 1,
full_results = FALSE,
return_addresses = TRUE,
verbose = FALSE,
progressbar = TRUE,
custom_query = list()
)
Arguments
address |
character with single line address, e.g.
( |
lat |
latitude column name in the output data (default |
long |
longitude column name in the output data (default |
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 |
return_addresses |
return input addresses with results if |
verbose |
if |
progressbar |
Logical. If |
custom_query |
A named list with API-specific parameters to be used
(i.e. |
Details
See https://nominatim.org/release-docs/latest/api/Search/ for additional
parameters to be passed to custom_query
.
Value
A tibble with the results.
See Also
geo_lite_sf()
, tidygeocoder::geo()
Geocoding strings:
geo_address_lookup()
,
geo_address_lookup_sf()
,
geo_lite_sf()
Examples
geo_lite("Madrid, Spain")
# Several addresses
geo_lite(c("Madrid", "Barcelona"))
# With options: restrict search to USA
geo_lite(c("Madrid", "Barcelona"),
custom_query = list(countrycodes = "US"),
full_results = TRUE
)