cbsa_in_z: CBSA Addresses in Zip Addresses?

In etam4260/rhud: A R interface for accessing HUD (US Department of Housing and Urban Development) APIs

CBSA Addresses in Zip Addresses?

Description

Given a cbsa(s) and a zip(s), determine if they overlap using the (United States Postal Service) USPS Crosswalk files. Overlap will be described if any residential, business, other, or total addresses reside in both.

Usage

cbsa_in_z(cbsa, zip, year, quarter, key = Sys.getenv("HUD_KEY"))

Arguments

cbsa	A character or numeric vector: the cbsa(s) to determine overlap with zip(s).
zip	A character or numeric vector: the zip(s) to determine overlap with cbsa(s).
year	A character or numeric vector: gets the year that this data was recorded. Can specify multiple years. Default is the previous year.
quarter	A character or numeric vector: gets the quarter of the year that this data was recorded. Defaults to the first quarter of the year.
key	A character vector of length one: the API key for this user. You must go to HUD and sign up for an account and request for an API key.

Value

If cbsa(s) exist in the zip(s) specified, then TRUE is returned.

See Also

• z_in_trt()

• z_in_cty()

• z_in_cbsa()

• z_in_cbsadiv()

• z_in_ctysb()

• z_in_cd

• trt_in_z()

• cty_in_z()

• cbsa_in_z()

• cbsadiv_in_z()

• cd_in_z()

• ctysb_in_z()

Examples

## Not run: 

cbsa_in_z(cbsa = 43340, zip = 71052, year = 2019, quarter = 1)


## End(Not run)

etam4260/rhud documentation built on Nov. 12, 2022, 2:53 a.m.