Geocoding using the ArcGIS REST API with multi-field query
Source:R/arc_geo_multi.R
arc_geo_multi.Rd
Geocodes addresses given specific address components.This function returns
the tibble
associated with the query.
For geocoding using a single text string use arc_geo()
function.
Usage
arc_geo_multi(
address = NULL,
address2 = NULL,
address3 = NULL,
neighborhood = NULL,
city = NULL,
subregion = NULL,
region = NULL,
postal = NULL,
postalext = NULL,
countrycode = NULL,
lat = "lat",
long = "lon",
limit = 1,
full_results = FALSE,
return_addresses = TRUE,
verbose = FALSE,
progressbar = TRUE,
outsr = NULL,
langcode = NULL,
category = NULL,
custom_query = list()
)
Arguments
- address, address2, address3, neighborhood, city, subregion
Address components (See Details).
- region, postal, postalext, countrycode
More address components, see (See Details).
- lat
latitude column name in the output data (default
"lat"
).- long
longitude column name in the output data (default
"lon"
).- limit
maximum number of results to return per input address. Note that each query returns a maximum of 50 results.
- full_results
returns all available data from the API service. This is a shorthand of
outFields=*
. See References. IfFALSE
(default) only the default values of the API would be returned. See alsoreturn_addresses
argument.- return_addresses
return input addresses with results if
TRUE
.- verbose
if
TRUE
then detailed logs are output to the console.- progressbar
Logical. If
TRUE
displays a progress bar to indicate the progress of the function.- outsr
The spatial reference of the
x,y
coordinates returned by a geocode request. By default isNULL
(i.e. the parameter won't be used in the query). See Details and arc_spatial_references.- langcode
Sets the language in which reverse-geocoded addresses are returned.
- category
A place or address type that can be used to filter results. Several values can be used as well as a vector (i.e.
c("Cinema", "Museum")
). See arc_categories for details.- custom_query
API-specific parameters to be used, passed as a named list.
Value
A tibble
object with the results. See the details of the output in ArcGIS REST API Service output.
The resulting output would include also the input parameters (columns with
prefix q_
) for better tracking the results.
Details
More info and valid values in the ArcGIS REST docs.
Address components
This function allows to perform structured queries by different components of
an address. At least one field should be different than NA
or NULL
.
A vector of values can be provided for each parameter for multiple geocoding. When using vectors on different parameters, their lengths should be the same.
The following list provides a brief description of each parameter:
address
: A string that represents the first line of a street address. In most cases it will be the street name and house number input, but it can also be used to input building name or place-name.address2
: A string that represents the second line of a street address. This can include street name/house number, building name, place-name, or sub unit.address3
: A string that represents the third line of a street address. This can include street name/house number, building name, place-name, or sub unit.neighborhood
: The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place.city
: The next largest administrative division associated with an address, typically, a city or municipality.subregion
: The next largest administrative division associated with an address. Depending on the country, a sub region can represent a county, state, or province.region
: The largest administrative division associated with an address, typically, a state or province.postal
: The standard postal code for an address, typically, a three– to six-digit alphanumeric code.postalext
: A postal code extension, such as the United States Postal Service ZIP+4 code.countrycode
: A value representing the country. Providing this value increases geocoding speed. Acceptable values include the full country name in English or the official language of the country, the two-character country code, or the three-character country code.
outsr
The spatial reference can be specified as either a well-known ID (WKID). If not specified, the spatial reference of the output locations is the same as that of the service ( WGS84, i.e. WKID = 4326)).
See arc_spatial_references for values and examples.
See also
Other functions for geocoding:
arc_geo()
,
arc_geo_categories()
,
arc_reverse_geo()
Examples
# \donttest{
simple <- arc_geo_multi(
address = "Plaza Mayor", limit = 10,
custom_query = list(outFields = c("LongLabel", "CntryName", "Region"))
)
library(dplyr)
simple %>%
select(lat, lon, CntryName, Region, LongLabel) %>%
slice_head(n = 10)
#> # A tibble: 10 × 5
#> lat lon CntryName Region LongLabel
#> <dbl> <dbl> <chr> <chr> <chr>
#> 1 41.7 -4.73 España Castilla y León Plaza Mayor, Valladolid, Castilla y …
#> 2 39.5 -6.37 España Extremadura Plaza Mayor, Cáceres, Extremadura, E…
#> 3 21.2 -102. México Guanajuato Plaza Mayor, León, Guanajuato, MEX
#> 4 6.24 -75.6 Colombia Antioquia Plaza Mayor, Carrera 55, Calle Nueva…
#> 5 5.63 -73.5 Colombia Boyacá Plaza Mayor, Carrera 10, Villa de Le…
#> 6 21.8 -80.0 Cuba Sancti Spíritus Plaza Mayor, Trinidad, Sancti Spírit…
#> 7 37.4 -2.15 España Andalucía Plaza Mayor, 04800, Albox, Almería, …
#> 8 38.2 -3.77 España Andalucía Plaza Mayor, Plaza Constitución, 237…
#> 9 40.3 -1.10 España Aragón Plaza Mayor, Calle Mayor Arrabal, 44…
#> 10 43.2 -4.62 España Cantabria Plaza Mayor, 39570, Potes, Cantabria…
# Restrict search to Spain
simple2 <- arc_geo_multi(
address = "Plaza Mayor", countrycode = "ESP",
limit = 10,
custom_query = list(outFields = c("LongLabel", "CntryName", "Region"))
)
simple2 %>%
select(lat, lon, CntryName, Region, LongLabel) %>%
slice_head(n = 10)
#> # A tibble: 10 × 5
#> lat lon CntryName Region LongLabel
#> <dbl> <dbl> <chr> <chr> <chr>
#> 1 41.7 -4.73 España Castilla y León Plaza Mayor, Valladolid, Castilla y Le…
#> 2 39.5 -6.37 España Extremadura Plaza Mayor, Cáceres, Extremadura, ESP
#> 3 37.4 -2.15 España Andalucía Plaza Mayor, 04800, Albox, Almería, An…
#> 4 38.2 -3.77 España Andalucía Plaza Mayor, Plaza Constitución, 23711…
#> 5 40.3 -1.10 España Aragón Plaza Mayor, Calle Mayor Arrabal, 4400…
#> 6 43.2 -4.62 España Cantabria Plaza Mayor, 39570, Potes, Cantabria, …
#> 7 40.5 -5.27 España Castilla y León Plaza Mayor, Plaza del Generalísimo, 0…
#> 8 40.4 -5.61 España Castilla y León Plaza Mayor, calle Mayor 68, 05619, Gi…
#> 9 42.0 -3.60 España Castilla y León Plaza Mayor, Calle De La Plaza 13, 093…
#> 10 42.0 -3.76 España Castilla y León Plaza Mayor, 09340, Lerma, Burgos, Cas…
# Restrict to a region
simple3 <- arc_geo_multi(
address = "Plaza Mayor", region = "Segovia",
countrycode = "ESP",
limit = 10,
custom_query = list(outFields = c("LongLabel", "CntryName", "Region"))
)
simple3 %>%
select(lat, lon, CntryName, Region, LongLabel) %>%
slice_head(n = 10)
#> # A tibble: 10 × 5
#> lat lon CntryName Region LongLabel
#> <dbl> <dbl> <chr> <chr> <chr>
#> 1 41.4 -4.31 España Castilla y León Plaza Mayor, Calle del Colegio 4, 4020…
#> 2 41.1 -4.43 España Castilla y León Plaza Mayor, Calle Nieva de Cameros, 4…
#> 3 41.0 -4.12 España Castilla y León Plaza Mayor, Calle del Cronista Lecea …
#> 4 40.9 -4.27 España Castilla y León Plaza Mayor, 40141, Abades, Segovia, C…
#> 5 41.4 -4.11 España Castilla y León Plaza Mayor, 40354, Adrados, Segovia, …
#> 6 41.2 -4.17 España Castilla y León Plaza Mayor, 40292, Aldea Real, Segovi…
#> 7 41.5 -3.47 España Castilla y León Plaza Mayor, 40555, Aldealengua de San…
#> 8 41.1 -4.54 España Castilla y León Plaza Mayor, 40462, Aldehuela del Codo…
#> 9 41.0 -4.31 España Castilla y León Plaza Mayor, 40121, Anaya, Segovia, Ca…
#> 10 41.0 -4.30 España Castilla y León Plaza Mayor, 40492, Añe, Segovia, Cast…
# }