| Title: | Providing Data from the US Department of Housing and Urban Development |
|---|---|
| Description: | Provides functions to access data from the US Department of Housing and Urban Development <https://www.huduser.gov/portal/dataset/fmr-api.html>. |
| Authors: | Paul Richardson |
| Maintainer: | Paul Richardson <[email protected]> |
| License: | GPL (>= 3) |
| Version: | 1.2.0 |
| Built: | 2024-08-29 07:14:12 UTC |
| Source: | CRAN |
Provides functions to access data from the US Department of Housing and Urban Development https://www.huduser.gov/portal/dataset/fmr-api.html.
Provides data from the US Department of Housing and Urban Development (HUD).
<https://www.huduser.gov/portal/dataset/fmr-api.html>
Provides Comprehensive Housing Affordability Strategy (CHAS) data at the Place, MCD, County, State, National Level from HUD.
get_hud_chas_data( entityid, stateid, type, yr, hud_key = Sys.getenv("HUD_API_KEY") )get_hud_chas_data( entityid, stateid, type, yr, hud_key = Sys.getenv("HUD_API_KEY") )
entityid |
Character string containing the 'fips_code' from get_hud_fmr_listcounties(...) or 'cbsa_code' from get_hud_fmr_listmetros(...). |
stateid |
Character string containing the 'fips_code' for the State. |
type |
Character string indicating the summary level. Option include 1-5. 1 - Nation, 2 - State, 3 - County, 4 - MCD, 5 - Place. |
yr |
Character string indicating the year. |
hud_key |
Character string indicating your API key from HUD. |
Provides fair market rent data at the County and MSA level from HUD.
A list of data tables containing fair market rent data from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") chas_cnty_dt <- get_hud_chas_data(entityid = "033", stateid = "53", type = "3", yr = "2014-2018", hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") chas_cnty_dt <- get_hud_chas_data(entityid = "033", stateid = "53", type = "3", yr = "2014-2018", hud_key = hud_key) ## End(Not run)
Provides a data.table containing the entityIds for all of the counties within a given state for the Comprehensive Housing Affordability Strategy (CHAS) data from HUD.
get_hud_chas_entityid_list( stateid, geo_lvl, hud_key = Sys.getenv("HUD_API_KEY") )get_hud_chas_entityid_list( stateid, geo_lvl, hud_key = Sys.getenv("HUD_API_KEY") )
stateid |
Character string containing the 'fips_code' for the State. |
geo_lvl |
Character string indicating either "county", "MDC", or "city". |
hud_key |
Character string indicating your API key from HUD. |
Provides fair market rent data at the County and MSA level from HUD.
A list of data tables containing fair market rent data from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") chas_cnty_lst_dt <- get_hud_chas_entityid_list(stateid = "53", geo_lvl = "county", hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") chas_cnty_lst_dt <- get_hud_chas_entityid_list(stateid = "53", geo_lvl = "county", hud_key = hud_key) ## End(Not run)
Provides fair market rent data at the County and MSA level from HUD.
get_hud_fmr_data(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))get_hud_fmr_data(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))
entityid |
Character string containing the 'fips_code' from get_hud_fmr_listcounties(...) or 'cbsa_code' from get_hud_fmr_listmetros(...). |
yr |
Character string indicating the year. |
hud_key |
Character string indicating your API key from HUD. Default is Sys.getenv("HUD_API_KEY"). |
Provides fair market rent data at the County and MSA level from HUD.
A list of data tables containing fair market rent data from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") cbsa_codes <- get_hud_fmr_listmetros(hud_key = hud_key) cnty_codes <- get_hud_fmr_listcounties(hud_key = hud_key) fmr_msa_dt <- get_hud_fmr_data(entityid = cbsa_codes$cbsa_code[1], yr = "2020", hud_key = hud_key) fmr_cnty_dt <- get_hud_fmr_data(entityid = cnty_codes$fips_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") cbsa_codes <- get_hud_fmr_listmetros(hud_key = hud_key) cnty_codes <- get_hud_fmr_listcounties(hud_key = hud_key) fmr_msa_dt <- get_hud_fmr_data(entityid = cbsa_codes$cbsa_code[1], yr = "2020", hud_key = hud_key) fmr_cnty_dt <- get_hud_fmr_data(entityid = cnty_codes$fips_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)
Provides list of county codes data from HUD.
get_hud_fmr_listcounties(stateid, hud_key = Sys.getenv("HUD_API_KEY"))get_hud_fmr_listcounties(stateid, hud_key = Sys.getenv("HUD_API_KEY"))
stateid |
Character string indicating the state. |
hud_key |
Character string indicating your API key from HUD. |
Provides list of county codes data from HUD.
A data table containing a list of county codes from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_listcounties(hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_listcounties(hud_key = hud_key) ## End(Not run)
Provides list of MSA codes data from HUD.
get_hud_fmr_listmetros(hud_key = Sys.getenv("HUD_API_KEY"))get_hud_fmr_listmetros(hud_key = Sys.getenv("HUD_API_KEY"))
hud_key |
Character string indicating your API key from HUD. |
Provides list of MSA codes from HUD.
A data table containing a list of MSA codes from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") cbsa_codes <- get_hud_fmr_listmetros(hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") cbsa_codes <- get_hud_fmr_listmetros(hud_key = hud_key) ## End(Not run)
Provides list of state codes data from HUD.
get_hud_fmr_liststates(hud_key = Sys.getenv("HUD_API_KEY"))get_hud_fmr_liststates(hud_key = Sys.getenv("HUD_API_KEY"))
hud_key |
Character string indicating your API key from HUD. |
Provides list of state codes data from HUD.
A data table containing a list of state codes from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_liststates(hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_liststates(hud_key = hud_key) ## End(Not run)
Provides fair market rent data at the State level from HUD.
get_hud_fmr_statedata(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))get_hud_fmr_statedata(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))
entityid |
Character string containing the 'state_code' from get_hud_fmr_liststates(...). |
yr |
Character string indicating the year. |
hud_key |
Character string indicating your API key from HUD. Default is Sys.getenv("HUD_API_KEY"). |
Provides fair market rent data at the State level from HUD.
A list of data tables containing fair market rent data from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_liststates(hud_key = hud_key) fmr_state_dt <- get_hud_fmr_statedata(entityid = state_codes$state_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_liststates(hud_key = hud_key) fmr_state_dt <- get_hud_fmr_statedata(entityid = state_codes$state_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)
Provides income limit data at the County and MSA level from HUD.
get_hud_il_data(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))get_hud_il_data(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))
entityid |
Character string containing the 'fips_code' from get_hud_fmr_listcounties(...) or 'cbsa_code' from get_hud_fmr_listmetros(...). |
yr |
Character string indicating the year. |
hud_key |
Character string indicating your API key from HUD. Default is Sys.getenv("HUD_API_KEY"). |
Provides income limit data at the County and MSA level from HUD.
A list of data tables containing income limit data from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") cbsa_codes <- get_hud_fmr_listmetros(hud_key = hud_key) cnty_codes <- get_hud_fmr_listcounties(hud_key = hud_key) il_msa_dt <- get_hud_il_data(entityid = cbsa_codes$cbsa_code[1], yr = "2020", hud_key = hud_key) il_cnty_dt <- get_hud_il_data(entityid = cnty_codes$fips_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") cbsa_codes <- get_hud_fmr_listmetros(hud_key = hud_key) cnty_codes <- get_hud_fmr_listcounties(hud_key = hud_key) il_msa_dt <- get_hud_il_data(entityid = cbsa_codes$cbsa_code[1], yr = "2020", hud_key = hud_key) il_cnty_dt <- get_hud_il_data(entityid = cnty_codes$fips_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)
Provides income limit data at the State level from HUD.
get_hud_il_statedata(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))get_hud_il_statedata(entityid, yr, hud_key = Sys.getenv("HUD_API_KEY"))
entityid |
Character string containing the 'state_code' from get_hud_fmr_liststates(...). |
yr |
Character string indicating the year. |
hud_key |
Character string indicating your API key from HUD. Default is Sys.getenv("HUD_API_KEY"). |
Provides income limit data at the State level from HUD.
A list of data tables containing income limit data from HUD.
Paul Richardson
## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_liststates(hud_key = hud_key) il_state_dt <- get_hud_il_statedata(entityid = state_codes$state_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)## Not run: library(hudr) hud_key <- Sys.getenv("HUD_API_KEY") state_codes <- get_hud_fmr_liststates(hud_key = hud_key) il_state_dt <- get_hud_il_statedata(entityid = state_codes$state_code[1], yr = "2020", hud_key = hud_key) ## End(Not run)