cole-brokamp / addr

Clean, Parse, Harmonize, and Hash Messy Real-World Addresses

addr

The goal of addr is to clean, parse, harmonize, and hash messy real-world addresses in R.

Addresses that were not validated at the time of collection are often heterogenously formatted, making them difficult to compare or link to other sets of addresses. The addr package is designed to (1) clean character strings of addresses, (2) use the usaddress library to tag address components, (3) expand common street type abbreviations, and (4) paste together select components to create a standardized address. Standardized addresses can be hashed to create hashdresses that can be used to merge with other sets of addresses.

Installation

You can install the development version of addr from GitHub with:

# install.packages("pak")
pak::pak("cole-brokamp/addr")

addr requires a working Rust toolchain; install one using rustup.

Example

library(addr)

Transform messy, real-world addresses into a character vector of standardized address:

addr_standardize(
  x = c(
    "3333 Burnet Avenue Apt 2 Cincinnati OH 45220",
    "3333 bUrNeT Avenue Cincinnati OH 45220",
    "3333 Burnet Avenue Apt #2 Cincinnati OH 45220",
    "3333 Burnet Ave Cincinnati OH 45220",
    "3333 Burnet Av. Cincinnati OH 45220"
  )
)
#> [1] "3333 burnet avenue cincinnati oh 45220"
#> [2] "3333 burnet avenue cincinnati oh 45220"
#> [3] "3333 burnet avenue cincinnati oh 45220"
#> [4] "3333 burnet avenue cincinnati oh 45220"
#> [5] "3333 burnet avenue cincinnati oh 45220"

Use a hash representing the standardized address instead:

addr_hash(
  x = c(
    "3333 Burnet Avenue Apt 2 Cincinnati OH 45220",
    "3333 bUrNeT Avenue Cincinnati OH 45220",
    "3333 Burnet Avenue Apt #2 Cincinnati OH 45220",
    "3333 Burnet Ave Cincinnati OH 45220",
    "3333 Burnet Av. Cincinnati OH 45220"
  )
)
#> [1] "da219816d9cb3e1bb53291312cfa1dfd" "da219816d9cb3e1bb53291312cfa1dfd"
#> [3] "da219816d9cb3e1bb53291312cfa1dfd" "da219816d9cb3e1bb53291312cfa1dfd"
#> [5] "da219816d9cb3e1bb53291312cfa1dfd"

For finer control, use addr_tag() to generate tagged address components:

addr_tag(c("290 Ludlow Avenue Apt #2 Cincinnati OH 45220", "3333 Burnet Ave Cincinnati OH 45219"))
#> [[1]]
#>       AddressNumber          StreetName  StreetNamePostType       OccupancyType 
#>               "290"            "Ludlow"            "Avenue"               "Apt" 
#> OccupancyIdentifier           PlaceName           StateName             ZipCode 
#>                 "2"        "Cincinnati"                "OH"             "45220" 
#> 
#> [[2]]
#>      AddressNumber         StreetName StreetNamePostType          PlaceName 
#>             "3333"           "Burnet"              "Ave"       "Cincinnati" 
#>          StateName            ZipCode 
#>               "OH"            "45219"