get_il: Load Income Limits from the HUD API

In CenterOnBudget/hudapi: Load Data From the HUD API Into R

Description

get_il() loads Income Limits for a given state, county, or metro area from the HUD API.

Usage

get_il(
  geography,
  entityid,
  year,
  token = get_token(),
  drop_empty_cols = TRUE,
  tibble = TRUE,
  show_url = FALSE
)

Arguments

geography	Geography of data to pull. One of "state", "county", or "metro".
entityid	ID of entity to pull data for. If geography is "state", ID should be a two-letter state abbreviation. The 50 states are supported. If geography is "county", ID should be a 10-character county code. If geography is "metro", ID should be a 16-character METRO code. Using get_geo() to look up county and METRO codes is recommended.
year	Year to pull data for. Currently, years 2017 to 2020 are supported.
token	HUD API access token. Defaults to environment variable HUD_API_TOKEN.
drop_empty_cols	If TRUE (default), drop empty columns in returned data.
tibble	If TRUE (default), return data as a tibble. Otherwise, return data as a base data frame.
show_url	If TRUE, show URL the request was sent to. Defaults to FALSE.

Value

A tibble or base data frame with requested data.

CenterOnBudget/hudapi documentation built on July 6, 2021, 2:53 p.m.