R: Reverse geocode coordinates in a dataframe

reverse_geocode {tidygeocoder}

R Documentation

Reverse geocode coordinates in a dataframe

Description

Takes a dataframe containing coordinates (latitude and longitude) and returns the reverse geocoding query results from a specified service by using the reverse_geo function. See example usage in vignette("tidygeocoder").

This function passes all additional parameters (...) to the reverse_geo function, so you can refer to its documentation for more details on possible arguments.

Usage

reverse_geocode(
  .tbl,
  lat,
  long,
  address = "address",
  return_input = TRUE,
  limit = 1,
  return_coords = NULL,
  unique_only = FALSE,
  ...
)

Arguments

`.tbl`	dataframe containing coordinates
`lat`	latitude column name (input data). Can be quoted or unquoted (ie. lat or 'lat').
`long`	longitude column name (input data). Can be quoted or unquoted (ie. long or 'long').
`address`	address column name (output data). Can be quoted or unquoted (ie. addr or 'addr').
`return_input`	if TRUE then the input dataset will be combined with the geocoder query results and returned. If FALSE only the geocoder results will be returned.
`limit`	maximum number of results to return per input coordinate. For many geocoding services the maximum value of the limit parameter is 100. Pass `limit = NULL` to use the default `limit` value of the selected geocoding service. For batch geocoding, limit must be set to 1 (default) if `return_coords = TRUE`. To use `limit > 1` or `limit = NULL` set return_input to FALSE. Refer to api_parameter_reference for more details.
`return_coords`	if TRUE return input coordinates. Defaults to TRUE if `return_input` is FALSE and FALSE if `return_input` is TRUE. This argument is passed to the `reverse_geo()` function.
`unique_only`	if TRUE then only unique results will be returned and return_input will be set to FALSE.
`...`	arguments passed to the reverse_geo function

Value

tibble (dataframe)

Examples


library(tibble)
library(dplyr, warn.conflicts = FALSE)

tibble(
    latitude = c(38.895865, 43.6534817),
    longitude = c(-77.0307713,-79.3839347)
  ) %>%
  reverse_geocode(
    lat = latitude,
    long = longitude,
    method = 'osm',
    full_results = TRUE
  )

louisville %>% head(3) %>% 
  reverse_geocode(lat = latitude, long = longitude, 
  method = 'arcgis')

louisville %>% head(2) %>% 
  reverse_geocode(lat = latitude, long = longitude,  
  method = 'osm',
  limit = 2, return_input = FALSE)