grapes-z_in_ctysb-grapes: Zip Addresses in Countysub Addresses?

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

Zip Addresses in Countysub Addresses?

Description

To use this function, the HUD_KEY system environment variable must be set first: use hud_set_key("the_key") to do this.

Given zip code(s) and a countysub(s), determine if they overlap using the crosswalk files. Overlap will be described if any residential, business, other, or total addresses reside in both.

This means that it is possible that certain geoids(lhs) are not counted even though their boundaries intersect the queried geoids(rhs). This is likely because addresses do not lie in their intersecting region.

Infix operators default to most recent year and quarter of which the crosswalk files are available. For modifying the year and quarter parameter, take a look at their non-infix versions.

Usage

zip %z_in_ctysb% countysub

Arguments

zip	The zip(s) to determine overlap with countysub(s)
countysub	The countysub(s) to determine overlap with zip(s)

Value

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

Examples

## Not run: 

71052 %z_in_ctysb% 2203194756


## End(Not run)

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