arc_geo_multi {arcgeocoder} | R Documentation |
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.
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()
)
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 |
long |
longitude column name in the output data (default |
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 |
return_addresses |
return input addresses with results if |
verbose |
if |
progressbar |
Logical. If |
outsr |
The spatial reference of the |
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.
|
custom_query |
API-specific parameters to be used, passed as a named list. |
More info and valid values in the ArcGIS REST docs.
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.
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.
ArcGIS REST findAddressCandidates
Other functions for geocoding:
arc_geo()
,
arc_geo_categories()
,
arc_reverse_geo()
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)
# 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)
# 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)