geocode {photon} | R Documentation |
Geocode arbitrary text strings. Unstructured geocoding is more flexible but generally less accurate than structured geocoding.
geocode(
texts,
limit = 3,
lang = "en",
bbox = NULL,
osm_tag = NULL,
layer = NULL,
locbias = NULL,
locbias_scale = NULL,
zoom = NULL,
progress = interactive()
)
texts |
Character vector of a texts to geocode. |
limit |
Number of results to return. Defaults to 3. |
lang |
Language of the results. |
bbox |
Any object that can be parsed by |
osm_tag |
Character string giving an OSM tag to filter the results by. See details. |
layer |
Character string giving a layer to filter the results by.
Can be one of |
locbias |
Numeric vector of length 2 or any object that can be coerced
to a length-2 numeric vector (e.g. a list or |
locbias_scale |
Numeric vector specifying the importance of prominence
in |
zoom |
Numeric specifying the radius for which the |
progress |
If |
Filtering by OpenStreetMap tags follows a distinct syntax explained on https://github.com/komoot/photon. In particular:
Include places with tag: key:value
Exclude places with tag: !key:value
Include places with tag key: key
Include places with tag value: :value
Exclude places with tag key: !key
Exclude places with tag value: :!value
An sf dataframe or tibble containing the following columns:
idx
: Internal ID specifying the index of the texts
parameter.
osm_type
: Type of OSM element, one of N (node), W (way),
R (relation), or P (polygon).
osm_id
: OpenStreetMap ID of the matched element.
country
: Country of the matched place.
city
: City of the matched place.
osm_key
: OpenStreetMap key.
countrycode
: ISO2 country code.
housenumber
: House number, if applicable.
postcode
: Post code, if applicable.
locality
: Locality, if applicable.
street
: Street, if applicable.
district
: District name, if applicable.
osm_value
: OpenStreetMap tag value.
name
: Place name.
type
: Layer type as described for the layer
parameter.
extent
: Boundary box of the match.
# an instance must be mounted first
photon <- new_photon()
# geocode a city
geocode("Berlin")
# return more results
geocode("Berlin", limit = 10)
# return the results in german
geocode("Berlin", limit = 10, lang = "de")
# limit to cities
geocode("Berlin", layer = "city")
# limit to European cities
geocode("Berlin", bbox = c(xmin = -71.18, ymin = 44.46, xmax = 13.39, ymax = 52.52))
# search for museums in berlin
geocode("Berlin", osm_tag = "tourism:museum")
# search for touristic attractions in berlin
geocode("Berlin", osm_tag = "tourism")
# search for anything but tourism
geocode("Berlin", osm_tag = "!tourism")
# use location biases to match Berlin, IL instead of Berlin, DE
geocode("Berlin", locbias = c(-100, 40), locbias_scale = 0.1, zoom = 7, osm_tag = "place")