Skip to content

Latest commit

 

History

History
273 lines (209 loc) · 10.2 KB

README.md

File metadata and controls

273 lines (209 loc) · 10.2 KB
Raw

rhud

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Lifecycle: maturing R-CMD-check Codecov test coverage CodeFactor Status at rOpenSci Software Peer Review DOI

devel version

Citation

Please cite this package using:

Tam E, Reilly A, Ghaedi H, Jin S (2022). rhud: A R Interface to the HUD
      (US Department of Housing and Urban Development) APIs. 0.3.0.9000,
      https://github.com/etam4260/rhud/.

Are you a python developer? Check out hudpy instead.

Housing and Urban Development in R

This interface uses the HUD User Data API but is not endorsed or certified by HUD User

rhud main functionality is to help with the task of spatially allocating data associated with ZIP codes to and from other well-known geographic regions such as counties, congressional districts, metroareas, metroarea divisions, and census tracts.

rhud includes access to the USPS Crosswalk Files, Fair Markets Rent, Income Limits, and Comprehensive Housing and Affordability Strategy dataset APIs.

Please read https://www.huduser.gov/portal/dataset/api-terms-of-service.html for all terms of service.

According to HUD USER:

All services, which utilize or access the API, should display the following notice prominently within the application: “This product uses the HUD User Data API but is not endorsed or certified by HUD User.” You may use the HUD User name in order to identify the source of API content subject to these rules. You may not use the HUD User name, or the like to imply endorsement of any product, service, or entity, not-for-profit, commercial or otherwise.

HUD User

According to (HUD User Home Page | HUD USER), HUD User is a U.S. Department of Housing and Urban Development information source that includes reports and reference documents. HUD USER was founded in 1978 by the Department of Housing and Urban Development’s Office of Policy Development and Research.

HUD User maintains an API to gain access to their data. However, their API system can be confusing and provides their information in JSON format rather than a data-frame like object. Although there exist file downloadables, R users may want to be able to extract specific bits of the data into memory.

Installation

You can install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("etam4260/rhud")

For more details on how to setup and utilize this package. Please go to https://etam4260.github.io/rhud/. Select [Setup] in the navigation bar.

Key Access

To use functions provided by this package, you need to get access HUD USER via token. Go to https://www.huduser.gov/hudapi/public/login to register for an account and then create a token with access to all datasets provided by HUD. This will include selecting USPS Crosswalk, Fair Markets Rent, Income Limits, and Comprehensive Housing Affordability Strategy.

Now copy and paste that key into the hud_set_key() function to be used throughout your R session.

hud_set_key("sample-key")

Simplistic Example

This sample provided below shows how to query the USPS Crosswalk API

hud_cw_zip_tract(zip = '35213', year = c('2010'), quarter = c('1'))

Available Data

The APIs and datasets which this library interfaces are listed below. The HUD also provide miscellaneous supplemental APIs under them.

  1. HUD User
USPS Crosswalk Files Years
hud_cw_zip_tract() 2010-2021
hud_cw_zip_county() 2010-2021
hud_cw_zip_cbsa() 2010-2021
hud_cw_zip_cbsadiv() 2017-2021
hud_cw_zip_countysub() 2018-2021
hud_cw_zip_cd() 2010-2021
hud_cw_tract_zip() 2010-2021
hud_cw_county_zip() 2010-2021
hud_cw_cbsa_zip() 2010-2021
hud_cw_cbsadiv_zip() 2017-2021
hud_cw_cd_zip() 2010-2021
hud_cw_countysub_zip() 2018-2021
hud_cw() 2010-2021
crosswalk() 2010-2021
z_in_trt() 2010-2021
z_in_cty() 2010-2021
z_in_cbsa() 2010-2021
z_in_cbsadiv() 2017-2021
z_in_ctysb() 2018-2021
z_in_cd() 2010-2021
trt_in_z() 2010-2021
cty_in_z() 2010-2021
cbsa_in_z() 2010-2021
cbsadiv_in_z() 2017-2021
ctysb_in_z() 2018-2021
cd_in_z() 2010-2021
%z_in_trt% 2021
%z_in_cty% 2021
%z_in_cbsa% 2021
%z_in_cbsadiv% 2021
%z_in_ctysb% 2021
%z_in_cd% 2021
%trt_in_z% 2021
%cty_in_z% 2021
%cbsa_in_z% 2021
%cbsadiv_in_z% 2021
%ctysb_in_z% 2021
%cd_in_z% 2021
Fair Markets Rent Years
hud_fmr_state_counties() 2017-2022
hud_fmr_state_metroareas() 2017-2022
hud_fmr_county_zip() 2017-2022
hud_fmr_metroarea_zip() 2017-2022
hud_fmr() 2017-2022
Income Limits Years
hud_il() 2017-2022
Comprehensive Housing and Affordability Strategy Years
hud_chas_nation() 2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010
hud_chas_state() 2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010
hud_chas_county() 2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010
hud_chas_state_mcd() 2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010
hud_chas_state_place() 2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010
hud_chas() 2014-2018 , 2013-2017, 2012-2016, 2011-2015, 2010-2014, 2009-2013, 2008-2012, 2007-2011, 2006-2010
  • US Geographic Entities
US Geographies
hud_nation_states_territories()
hud_state_metropolitan()
hud_state_counties()
hud_state_places()
hud_state_minor_civil_divisions()
  • Key access
Management
hud_set_key()
hud_get_key()
hud_set_user_agent()
hud_get_user_agent()
  • Caching
Caching
hud_set_cache_dir()
hud_get_cache_dir()
hud_clear_cache()
  • Utilities
Utilities
rhud_website()
hud_rec_cw_yr()
hud_rec_fmr_yr()
hud_rec_il_yr()

Contributors

Disclaimers

  • License: GPL >= 2

  • To get citation information for rhud in R, type citation(package = ‘rhud’)

  • This interface uses the HUD User Data API but is not endorsed or certified by HUD User.

  • The limit on the maximum number of API calls is 1200 queries a min. Each function call does not correspond to a single API call!

  • This is a WIP so please report any issues or bugs to: https://github.com/etam4260/rhud/issues

  • This is open source, so please fork and introduce some pull requests!

References

HUD User Home Page: HUD USER. HUD User Home Page | HUD USER. (n.d.). Retrieved
        February 24, 2022, from https://www.huduser.gov/portal/home.html