{photon} is a simple interface and setup manager of the
photon OpenStreetMap geocoder. It features
unstructured, structured, and reverse geocoding. The package allows
requests to the public API but shines at setting up local instances to
enable high-performance offline geocoding.
To install the package from CRAN:
install.packages("photon")You can install the development version of photon from GitHub with:
# install.packages("remotes")
remotes::install_github("jslth/photon")When loading {photon}, the package assumes that you want send
geocoding requests to the public photon API. If you want to change this,
you can use the workhorse function new_photon(). Otherwise, you can
directly start geocoding.
library(photon)
places <- c("Paris", "Beijing", "Sao Paolo", "Kinshasa")
cities1 <- geocode(places, limit = 1, layer = "city")
cities1
#> Simple feature collection with 4 features and 12 fields
#> Geometry type: POINT
#> Dimension: XY
#> Bounding box: xmin: -46.63338 ymin: -23.55065 xmax: 110.7344 ymax: 48.8535
#> Geodetic CRS: WGS 84
#> # A tibble: 4 × 13
#> idx osm_type osm_id country osm_key countrycode osm_value name state type
#> <int> <chr> <dbl> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
#> 1 1 R 7.15e4 France place FR city Paris Ile-… city
#> 2 2 N 4.52e9 China place CN town Beij… Shan… city
#> 3 3 R 2.98e5 Brazil place BR municipa… São … São … city
#> 4 4 R 3.88e5 Democr… bounda… CD administ… Kins… Kins… city
#> # ℹ 3 more variables: extent <list>, county <chr>, geometry <POINT [°]>Reverse geocoding means taking point geometries and returning their addresses or place names.
cities2 <- reverse(cities1$geometry, limit = 1, layer = "city")
cities2
#> Simple feature collection with 4 features and 12 fields
#> Geometry type: POINT
#> Dimension: XY
#> Bounding box: xmin: -46.63338 ymin: -23.55065 xmax: 110.7344 ymax: 48.8535
#> Geodetic CRS: WGS 84
#> # A tibble: 4 × 13
#> idx osm_type osm_id country osm_key countrycode osm_value name state type
#> <int> <chr> <dbl> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
#> 1 1 R 7.15e4 France place FR city Paris Ile-… city
#> 2 2 N 4.52e9 China place CN town Beij… Shan… city
#> 3 3 R 2.98e5 Brazil place BR municipa… São … São … city
#> 4 4 R 3.88e5 Democr… bounda… CD administ… Kins… Kins… city
#> # ℹ 3 more variables: extent <list>, county <chr>, geometry <POINT [°]>all.equal(cities1, cities2)
#> [1] TRUE{photon} is designed to facilitate offline geocoding. new_photon()
can install photon locally. The following code would install and start
photon covering the country of Germany in the current working directory.
photon <- new_photon(path = "./photon", country = "Germany")
photon$start()- The
{photon}package by Timothée Giraud interfaces photon but does not allow the setup of local instances and was abandoned a while ago. - The
{revgeo}package by Michael Hudecheck implements reverse geocoding using (among others) photon. - The
{tidygeocoder}and{nominatimlite}packages implement general (OSM) geocoding using web APIs.