Skip to content

tidygeocoder 1.0.3

Compare
Choose a tag to compare
@jessecambon jessecambon released this 19 Apr 22:55

New Features

  • Added support for reverse geocoding with the new reverse_geo() and reverse_geocode() functions.
  • Added support for the OpenCage geocoder service (#67) (thanks @dpprdan).
  • Added support for the HERE (#74), Mapbox (#71), MapQuest (#85), TomTom (#76), Bing (#92), and ArcGIS (#98) geocoder services (thanks @dieghernan). Note that currently the batch geocoding capabilities for the Mapbox and ArcGIS services are not currently implemented (see #73 and #102).
    • Added the mapbox_permanent, here_request_id, and mapquest_open parameters to the geo() and reverse_geo() functions.
  • The limit argument can now be used with the "google" and "census" methods to control the number of results returned. These two services do not have limit arguments in their APIs so the limit is applied after the results are returned.
  • batch_limit is now automatically set according to the specified geocoder service unless otherwise specified.

Other Changes

  • Changed default method to "osm" (Nominatim) for the geo() function (it was previously "census").
  • The geo_<method> functions are now deprecated.
  • Added the return_input argument to geocode() and reverse_geocode() to provide more flexibility when using dataframes as inputs in geocoder queries.
  • limit = NULL can now be passed to use the default limit value for the geocoder service.
  • Added the min_time_reference, batch_limit_reference, api_key_reference, and api_info_reference datasets to more accessibly store values for min_time, batch_limit, the names of environmental variables for API keys, and information for documentation (such as API documentation links).
  • geocode() and reverse_geocode() now require limit = 1 (default) unless return_input = FALSE. This fixes a bug where geocoding results could be misaligned with the input dataset when limit > 1. (#88).
  • If the number of unique addresses or coordinates exceeds the batch query limit then an error is thrown by default. For forward geocoding, this behavior can be toggled with the new batch_limit_query argument in the geo() function and batch_limit_query is set to FALSE if using the "cascade" method. When batch_limit_query is FALSE then the batch query is limited to the batch limit and executed. In the past, all batch queries that exceeded the batch query limit would be limited to the batch limit and no error was thrown.
  • The address_list argument of query_api() has been renamed to input_list to reflect that it is used for both forward and reverse queries when using the Geocodio service for batch geocoding.
  • The query_api() function now returns a named list which contains the response content (content) and the HTTP status code (status). The geo() and reverse_geo() functions now use the HTTP status code directly to determine if a response is valid.
  • Added external tests to more thoroughly test the package with live queries (internal package tests don't run queries).
  • Added functions to generate package documentation from built-in datasets (ex. the methods documentation in geo() and reverse_geo()).
  • Converted package documentation from standard roxygen syntax to Markdown.