get_cost_burdening_by_income_and_tenure: Get Cost Burdening by Income and Tenure

Description Usage Arguments Examples

View source: R/get_cost_burdening_by_income_and_tenure.R

Description

This function uses the census API to pull down cost burdening data from table B25106 of the ACS. It then tidies the returned data.

Usage

1
2
3
4
5
6
7
get_cost_burdening_by_income_and_tenure(
  year = 2019,
  geography,
  state = NULL,
  county = NULL,
  survey = "acs5"
)

Arguments

year

Defaults to 2019, value passed to the census API call

geography

The unit of geography to return data for, options are "state", "county", "place" and "tract". This value is passed to the census API call

state

U.S. state to return data for, value passed to the census API call. Defaults to NULL

county

Defaults to NULL, option to return tract or county data from a specific county. Can't return place data from a specific county. This value is passed to census API call

survey

Defaults to "acs5", the version of the ACS to return. Options are "acs5" and "acs1" for either the five-year or one-year ACS survey. Value passed to census API call

Examples

1
get_cost_burdening_by_income_and_tenure(year = 2019, geography = "county", state = "ID", survey = "acs5")

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