Skip to contents

Comprehensive Housing and Affordability Strategy for US States.

Source: R/hud_chas.R
hud_chas_state.Rd

Returns Comprehensive Housing and Affordability Strategy (CHAS) data for state(s).

Usage

hud_chas_state(
  state,
  year = c("2014-2018"),
  key = Sys.getenv("HUD_KEY"),
  to_tibble = getOption("rhud_use_tibble", FALSE)
)

Arguments

state

A character or numeric vector: the state(s) to query for. Can supply as abbreviation, whole name, or as the fips code.

year

A character vector: the years to query for.

  • year = "2014-2018"

  • year = "2013-2017"

  • year = "2012-2016"

  • year = "2011-2015"

  • year = "2010-2014"

  • year = "2009-2013"

  • year = "2008-2012"

  • year = "2007-2011"

  • year = "2006-2010"

key

A character vector of length one with the key obtained from HUD (US Department of Housing and Urban Development) USER website.

to_tibble

A logical: if TRUE, return the data in a tibble format rather than a data frame.

Value

Returns a data frame with Comprehensive Housing and Affordability Strategy (CHAS) data for states for all combinations of "state" and "year" inputs.

See also

Examples

if (FALSE) {
hud_chas_state("CA")
hud_chas_state("51")
}