get_affordability_matrix_from_chas: Get Matrix of Household Income and Housing Affordability...

Description Usage Arguments Examples

View source: R/get_affordability_matrix_from_chas.R

Description

This function formats table 18 of the 2013-2017 CHAS data to return the "matrix" of units by household income and unit affordability.

Usage

1
2
3
4
5
get_affordability_matrix_from_chas(
  geography,
  state,
  bin_adjustment_type = "unify"
)

Arguments

geography

Options are "county" or "place", determines the geographic unit to return CHAS data for.

state

U.S. state to return data for, requires the state two letter abbreviation to be passed

bin_adjustment_type

Options are either "unify" or "low end ownership", if "unify" is selected the bins are unified across renters and owners which makes the results less granular but no assumptions are made. "low end ownership" preserves the 0-30pct affordability bin but assumes all ownership units in 0-50pct are actually in 30-50pct

Examples

1
get_affordability_matrix_from_chas(geography = "place", state = "ID", bin_adjustment_type = "unify")

buchmayne/housing-policy-tools documentation built on Feb. 17, 2021, 9:46 a.m.