Package 'OfflineGeocodeR'

Title: Geocoding Inside R Based on a Dockerized Offline TIGER/Line Range Geocoder
Description: Uses a local Docker installation to pull and run an offline geocoding container in the background. The geocode() function calls the container and aggregates the results, optionally using a cache for memoization.
Authors: Cole Brokamp [aut, cre]
Maintainer: Cole Brokamp <[email protected]>
License: GPL-3 + file LICENSE
Version: 0.2
Built: 2024-10-27 03:49:04 UTC
Source: https://github.com/geomarker-io/OfflineGeocodeR

Help Index


find the docker executable

Description

find the docker executable

Usage

find_docker_cmd()

call a running geocoding container to geocode an address

Description

This is used internally by geocode() and normally should not be called directly.

Usage

gc_call(address)

Arguments

address

a string; see vignette for best practices and examples


geocode

Description

To prevent errors and optimize accuracy, please remove non alphanumeric characters from address strings prior to geocoding. In general, address cleaning is outside the scope of this package and should be completed prior to geocoding.

Usage

geocode(addresses, ...)

Arguments

addresses

a list or vector addresses

...

additional arguments passed to CB::mappp; set options for cache here

Details

By default, geocoding results will be cached in a local folder named geocoding_cache. See help for CB::mappp to change these defaults.

Value

list of geocoding results with one address per element; some addresses may return more than one geocoding result if there is a tie among the best matches


start geocoding container

Description

start geocoding container

Usage

start_geocoder_container(image_name = "degauss/geocoder")

Arguments

image_name

name of geocoding image; can be used to specify the version i.e. degauss/geocoder_slim:2.4; defaults to degauss/geocoder_slim:latest


stop geocoding container

Description

stop geocoding container

Usage

stop_geocoder_container()