R/global_variables.R

In tidygeocoder: Geocoding Made Easy

# Global package variables


pkg.globals <- new.env()

# These are the input field names for forward geocoding
pkg.globals$address_arg_names <- c('address', 'street', 'city', 'county', 'state', 'postalcode', 'country')

# These are methods that should use single geocoding by default (ie. not batch).
# The reason in this case is that these batch methods are slower.
pkg.globals$single_first_methods <- c("here", "bing")

# These methods do not have limit API arguments, but use the limit parameter in 
# geo() or reverse_geo() to limit the number of results (ie. a passthrough)
pkg.globals$limit_passthru_methods <- c("census", "google")

# For services that don't offer global coverage, specify geographic limitations
pkg.globals$geographic_limitations <- list(
  'census' = "United States",
  'geocodio' = "United States and Canada"
)

# these methods do not support reverse geocoding
pkg.globals$no_reverse_methods <- c('census')

# default settings for the `api_options` argument in geo() and reverse_geo()
pkg.globals$default_api_options <- list(
  census_return_type = "locations", 
  iq_region = "us", 
  geocodio_v = 1.6, 
  geocodio_hipaa = FALSE,
  mapbox_permanent = FALSE, 
  mapquest_open = FALSE
  )