knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", fig.width = 8, fig.height = 5, fig.align = 'center' ) options(tibble.print_min = 5, tibble.print_max = 5)
Tidygeocoder makes getting data from geocoding services easy. A unified high-level interface is provided for a selection of supported geocoding services and results are returned in tibble (dataframe) format.
Note that you should exercise due diligence when geocoding sensitive data as tidygeocoder utilizes third party web services to perform geocoding. Refer to the documentation on your selected geocoding service for information on how your data will be utilized and stored. See further information on this subject here.
Features:
In addition to the usage examples below, see the Getting Started Vignette and blog posts on tidygeocoder.
To install the stable version from CRAN (the official R package servers):
install.packages('tidygeocoder')
Alternatively, you can install the latest development version from GitHub:
devtools::install_github("jessecambon/tidygeocoder")
In this first example we will geocode a few addresses using the geocode()
function and plot them on a map with ggplot.
library(dplyr, warn.conflicts = FALSE) library(tidygeocoder) # create a dataframe with addresses some_addresses <- tibble::tribble( ~name, ~addr, "White House", "1600 Pennsylvania Ave NW, Washington, DC", "Transamerica Pyramid", "600 Montgomery St, San Francisco, CA 94111", "Willis Tower", "233 S Wacker Dr, Chicago, IL 60606" ) # geocode the addresses lat_longs <- some_addresses %>% geocode(addr, method = 'osm', lat = latitude , long = longitude)
The geocode()
function geocodes addresses contained in a dataframe. The Nominatim ("osm") geocoding service is used here, but other services can be specified with the method
argument. Only latitude and longitude are returned from the geocoding service in this example, but full_results = TRUE
can be used to return all of the data from the geocoding service. See the geo()
function documentation for details.
knitr::kable(lat_longs)
Now that we have the longitude and latitude coordinates, we can use ggplot to plot our addresses on a map.
library(ggplot2) ggplot(lat_longs, aes(longitude, latitude), color = "grey99") + borders("state") + geom_point() + ggrepel::geom_label_repel(aes(label = name)) + theme_void()
To perform reverse geocoding (obtaining addresses from geographic coordinates), we can use the reverse_geocode()
function. The arguments are similar to the geocode()
function, but now we specify the input data columns with the lat
and long
arguments. The input dataset used here is the results of the geocoding query above.
The single line address is returned in a column named by the address
argument and all columns from the geocoding service results are returned because full_results = TRUE
. See the reverse_geo()
function documentation for more details.
reverse <- lat_longs %>% reverse_geocode(lat = latitude, long = longitude, method = 'osm', address = address_found, full_results = TRUE) %>% select(-addr, -licence)
knitr::kable(reverse)
For inspiration, here are a few articles (with code) that leverage tidygeocoder:
Contributions to the tidygeocoder package are welcome. File an issue for bug fixes or suggested features. If you would like to contribute code such as adding support for a new geocoding service, reference the developer notes for instructions and documentation.
Use the citation()
function:
citation('tidygeocoder')
wzxhzdk:9
Or refer to the citation page.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.