get_hud_chas_entityid_list {hudr}R Documentation

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

Description

Provides a data.table containing the entityIds for all of the counties within a given state for the Comprehensive Housing Affordability Strategy (CHAS) data from HUD.

Usage

get_hud_chas_entityid_list(
  stateid,
  geo_lvl,
  hud_key = Sys.getenv("HUD_API_KEY")
)

Arguments

stateid

Character string containing the 'fips_code' for the State.

geo_lvl

Character string indicating either "county", "MDC", or "city".

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_lst_dt <- get_hud_chas_entityid_list(stateid = "53",
                                               geo_lvl = "county",
                                               hud_key = hud_key)

## End(Not run)

[Package hudr version 1.2.0 Index]