get_hud_il_data: Get HUD Income Limit data at the County or MSA Level from...

In hudr: Providing Data from the US Department of Housing and Urban Development

Get HUD Income Limit data at the County or MSA Level from HUD.

Description

Provides income limit data at the County and MSA level from HUD.

Usage

get_hud_il_data(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))

Arguments

entityid	Character string containing the 'fips_code' from get_hud_fmr_listcounties(...) or 'cbsa_code' from get_hud_fmr_listmetros(...).
yr	Character string indicating the year.
hud_key	Character string indicating your API key from HUD. Default is Sys.getenv("HUD_API_KEY").

Details

Provides income limit data at the County and MSA level from HUD.

Value

A list of data tables containing income limit data from HUD.

Author(s)

Paul Richardson

Examples

## Not run: 
library(hudr)

hud_key <- Sys.getenv("HUD_API_KEY")

cbsa_codes <- get_hud_fmr_listmetros(hud_key = hud_key)
cnty_codes <- get_hud_fmr_listcounties(hud_key = hud_key)

il_msa_dt <- get_hud_il_data(entityid = cbsa_codes$cbsa_code[1],
                             yr = "2020",
                             hud_key = hud_key)
il_cnty_dt <- get_hud_il_data(entityid = cnty_codes$fips_code[1],
                              yr = "2020",
                              hud_key = hud_key)

## End(Not run)

hudr documentation built on Sept. 17, 2022, 5:05 p.m.