hud_chas_nation: Comprehensive Housing and Affordability Strategy for the US.

In etam4260/rhud: A R interface for accessing HUD (US Department of Housing and Urban Development) APIs

Comprehensive Housing and Affordability Strategy for the US.

Description

Returns Comprehensive Housing and Affordability Strategy (CHAS) data for the entire nation.

Usage

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

Arguments

year	A character vector with 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 the entire nation for all observations supplied in "year" input.

See Also

• hud_chas_nation()

• hud_chas_state()

• hud_chas_county()

• hud_chas_state_mcd()

• hud_chas_state_place()

• hud_chas()

Examples

## Not run: 

hud_chas_nation()


## End(Not run)

etam4260/rhud documentation built on Nov. 12, 2022, 2:53 a.m.