get_hud_chas_data {hudr}

Get HUD Comprehensive Housing Affordability Strategy (CHAS) data at the Place, MCD, County, State, National Level from HUD.

Description

Provides Comprehensive Housing Affordability Strategy (CHAS) data at the Place, MCD, County, State, National Level from HUD.

Usage

get_hud_chas_data(
  entityid,
  stateid,
  type,
  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(...).

stateid

Character string containing the 'fips_code' for the State.

type

Character string indicating the summary level. Option include 1-5. 1 - Nation, 2 - State, 3 - County, 4 - MCD, 5 - Place.

yr

Character string indicating the year.

hud_key

Character string indicating your API key from HUD.

Details

Provides fair market rent data at the County and MSA level from HUD.

Value

A list of data tables containing fair market rent data from HUD.

Author(s)

Paul Richardson

Examples

## Not run: 
library(hudr)

hud_key <- Sys.getenv("HUD_API_KEY")

chas_cnty_dt <- get_hud_chas_data(entityid = "033", stateid = "53",
                                  type = "3", yr = "2014-2018",
                                  hud_key = hud_key)

## End(Not run)