Merge pull request #183 from jessecambon/arcgis-addr-components

addresses #177 and #180

NEWS.md

@@ -5,8 +5,11 @@
 - Fixed code and documentation that incorrectly referred to `mapquest_open` as `mapbox_open`.
 - An error is now thrown if an `api_options` parameter is not compatible with the specified `method`.
 - A message is now displayed warning that `flatten=FALSE` is ignored for Geocodio and Mapquest (the output of these services requires flattening to avoid errors).
+- Address component parameters (street, city, state, postal code, and country) can now be used with the ArcGIS service ([#180](https://github.com/jessecambon/tidygeocoder/issues/180), [#ottothecow](https://github.com/ottothecow))
+- The ArcGIS service now returns all available parameters by default ([#177](https://github.com/jessecambon/tidygeocoder/issues/177), [#ottothecow](https://github.com/ottothecow))
 - Fixed a bug where the Geocodio service did not pass the correct address component parameter names ([#178](https://github.com/jessecambon/tidygeocoder/issues/178), [@ottothecow](https://github.com/ottothecow)).
 
+
 # tidygeocoder 1.0.5
 
 - Corrected documentation for the `quiet` parameter in `geo()` and `reverse_geo()`.

data-raw/api_parameter_reference.R

@@ -121,8 +121,14 @@ api_parameter_reference <- tibble::tribble(
   # ArcGis may not require an api key
 
   "arcgis", "address", "SingleLine", NA, FALSE,
+  "arcgis", "street", "address", NA, FALSE,
+  "arcgis", "city", "city", NA, FALSE,
+  "arcgis", "state", "region", NA, FALSE,
+  "arcgis", "postalcode", "postal", NA, FALSE,
+  "arcgis", "country", "countryCode", NA, FALSE,
   "arcgis", "limit", "maxLocations", "1", FALSE,
   "arcgis", "format", "f", "json", TRUE,
+  "arcgis", "outFields", "outFields", "*",TRUE, # see https://github.com/jessecambon/tidygeocoder/issues/177
 
   ########################### geoapify #################################
   # geoapify returns geojson by default

vignettes/geocoder_services.Rmd

@@ -85,10 +85,11 @@ See the [geo()](https://jessecambon.github.io/tidygeocoder/reference/geo.html) o
 - When used in batch mode, the **US Census** geocoder will return NA data when there are multiple results available for an address. The expectation is that you would see that a "Tie" is indicated and use single address geocoding to return the results for these addresses. See [#87](https://github.com/jessecambon/tidygeocoder/issues/87) for details.
 - When performing reverse geocoding, the **Mapbox** service requires a `types` parameter to be set if `limit > 1`. See [#104](https://github.com/jessecambon/tidygeocoder/issues/104).
 - The **Bing** batch geocoder does not use the `limit` parameter ([#106](https://github.com/jessecambon/tidygeocoder/issues/106)).
--   The US Census service supports street-level addresses only (ie. "11 Wall St New York, NY" is OK but "New York, NY" is not).
--   The Mapbox service is capable of performing batch geocoding when using the [permanent endpoint](https://docs.mapbox.com/api/search/geocoding/#batch-geocoding), but this capability is not currently implemented in tidygeocoder. If you'd like to add this capability to the package see [#73](https://github.com/jessecambon/tidygeocoder/issues/73).
--   The ArcGIS service is capable of performing [batch geocoding](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-geocode-addresses.htm), but this capability is not currently implemented in tidygeocoder. If you'd like to add this capability see [#102](https://github.com/jessecambon/tidygeocoder/issues/102).
--   For the ArcGIS service, an API Key is not strictly required if the service is used for search capabilities only (see [Free vs. paid operations](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-free-vs-paid.htm)). It is possible to include an API Key on the request via the `custom_query` parameter:
+- The US Census service supports street-level addresses only (ie. "11 Wall St New York, NY" is OK but "New York, NY" is not).
+- The Mapbox service is capable of performing batch geocoding when using the [permanent endpoint](https://docs.mapbox.com/api/search/geocoding/#batch-geocoding), but this capability is not currently implemented in tidygeocoder. If you'd like to add this capability to the package see [#73](https://github.com/jessecambon/tidygeocoder/issues/73).
+- The ArcGIS service is capable of performing [batch geocoding](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-geocode-addresses.htm), but this capability is not currently implemented in tidygeocoder. If you'd like to add this capability see [#102](https://github.com/jessecambon/tidygeocoder/issues/102).
+- For the ArcGIS service, an API Key is not strictly required if the service is used for search capabilities only (see [Free vs. paid operations](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-free-vs-paid.htm)). It is possible to include an API Key on the request via the `custom_query` parameter:
+- The ArcGIS service has an `outFields` parameter which specifies which fields are to be returned. As of tidygeocoder v1.0.6 this is set to `*` (all fields). To return only default fields use the following parameter in your query: `custom_query = list(outFields='')`. See [#177](https://github.com/jessecambon/tidygeocoder/issues/177) for more details.
 
 ``` r
 tidygeocoder::geo(address = "New York, USA", method = "arcgis",