cxy_single: Geocode Single Parsed Address

Description Usage Arguments Details Value Examples

View source: R/single.R

Description

Provides access to the structured single address geocoding API from the US Census Bureau.

Usage

1
2
3
4
5
6
7
8
9
cxy_single(
  street,
  city = NULL,
  state = NULL,
  zip = NULL,
  return = "locations",
  benchmark = "Public_AR_Current",
  vintage = NULL
)

Arguments

street

String containing street address

city

Optional String containing city

state

Optional String containing state

zip

Optional String or Integer containing 5-digit Zip Code

return

One of 'locations' or 'geographies' See Details.

benchmark

Optional ID or Name of Census Benchmark. See Details.

vintage

Optional ID or Name of Census Vintage. See Details.

Details

To obtain current valid benchmarks, use the cxy_benchmarks() function.

If you want to append census geographies, you must specify a valid vintage for your benchmark. You may use the cxy_vintages() function to obtain valid Vintages. See vignette('censusxy') for a full walkthrough.

Value

A data.frame containing matched address or NULL if not matches

Examples

1
2
cxy_single(street = "20 N Grand Blvd", city = "St Louis", state = "MO", zip = "63108",
    return = "locations")

censusxy documentation built on Feb. 18, 2021, 9:06 a.m.