rhud
A R interface for the US Department of Housing and Urban Development APIs
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (19.1%) to scientific vocabulary
Keywords
api
chas
crosswalk
fair-markets-rent
hud
income-limits
Last synced: 4 months ago
·
JSON representation
Repository
A R interface for the US Department of Housing and Urban Development APIs
Basic Info
- Host: GitHub
- Owner: etam4260
- License: other
- Language: R
- Default Branch: main
- Homepage: https://etam4260.github.io/rhud/index.html
- Size: 86.2 MB
Statistics
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 9
- Releases: 1
Topics
api
chas
crosswalk
fair-markets-rent
hud
income-limits
Created almost 4 years ago
· Last pushed about 3 years ago
Metadata Files
Readme
Changelog
Contributing
License
Code of conduct
Citation
Codemeta
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rhud
[](https://www.repostatus.org/#active)
[](https://www.tidyverse.org/lifecycle/#maturing)
[](https://github.com/etam4260/rhud/actions)
[](https://codecov.io/gh/etam4260/rhud?branch=main)
[](https://www.codefactor.io/repository/github/etam4260/rhud/overview/main)
[](https://github.com/ropensci/software-review/issues/524)
[](https://doi.org/10.5281/zenodo.6644503)
[]()
### 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](https://github.com/etam4260/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](https://www.huduser.gov/portal/datasets)
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](https://github.com/) with:
``` r
# 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.
``` {r, eval = FALSE}
hud_set_key("sample-key")
```
### Simplistic Example
This sample provided below shows how to query the USPS Crosswalk API
``` {r, eval = FALSE}
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](https://www.huduser.gov/portal/dataset/uspszip-api.html)
| 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](https://www.huduser.gov/portal/dataset/fmr-api.html)
+ Small Areas Fair Markets Rent
| 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](https://www.huduser.gov/portal/dataset/fmr-api.html)
| Income Limits | Years
|------------------------------------------|------------------------------------------------|
| `hud_il()` | 2017-2022 |
- [Comprehensive Housing and Affordability Strategy](https://www.huduser.gov/portal/dataset/chas-api.html)
| 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
* Emmet Tam(https://github.com/etam4260)[emmet_tam@yahoo.com]
* Allison Reilly[areilly2@umd.edu]
* Hamed Ghaedi[hghaedi@terpmail.umd.edu]
* Shuyu Jin(https://github.com/geojsy)[geojsy@umd.edu]
### 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
Owner
- Name: Emmet Tam
- Login: etam4260
- Kind: user
- Location: United States, Maryland
- Website: https://github.com/etam4260/etam4260
- Repositories: 2
- Profile: https://github.com/etam4260
IT Analyst @ Constellation Energy
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "rhud",
"description": " An R interface for accessing HUD (US Department of Housing and Urban Development) API. HUD USER has four main datasets, USPS Crosswalk, Fair Markets Rent, Income Limits, and the Comprehensive Housing Affordability Strategy.",
"name": "rhud: A R interface for accessing HUD (US Department of Housing and Urban Development) APIs",
"relatedLink": "https://etam4260.github.io/rhud/index.html",
"codeRepository": "https://github.com/etam4260/rhud",
"issueTracker": "https://github.com/etam4260/rhud/issues",
"license": "https://spdx.org/licenses/GPL-2.0",
"version": "0.3.0.9000",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.1.1 (2021-08-10)",
"author": [
{
"@type": "Person",
"givenName": "Emmet",
"familyName": "Tam",
"email": "emmet_tam@yahoo.com"
}
],
"contributor": [
{
"@type": "Person",
"givenName": "Allison",
"familyName": "Reilly",
"email": "areilly2@umd.edu"
},
{
"@type": "Person",
"givenName": "Hamed",
"familyName": "Ghaedi",
"email": "hghaedi@terpmail.umd.edu"
},
{
"@type": "Person",
"givenName": "Shuyu",
"familyName": "Jin",
"email": "geojsy@umd.edu"
}
],
"copyrightHolder": [
{
"@type": "Person",
"givenName": "Emmet",
"familyName": "Tam",
"email": "emmet_tam@yahoo.com"
}
],
"maintainer": [
{
"@type": "Person",
"givenName": "Emmet",
"familyName": "Tam",
"email": "emmet_tam@yahoo.com"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "covr",
"name": "covr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=covr"
},
{
"@type": "SoftwareApplication",
"identifier": "httptest",
"name": "httptest",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=httptest"
},
{
"@type": "SoftwareApplication",
"identifier": "knitr",
"name": "knitr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=knitr"
},
{
"@type": "SoftwareApplication",
"identifier": "rmarkdown",
"name": "rmarkdown",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rmarkdown"
},
{
"@type": "SoftwareApplication",
"identifier": "devtools",
"name": "devtools",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=devtools"
},
{
"@type": "SoftwareApplication",
"identifier": "tigris",
"name": "tigris",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=tigris"
},
{
"@type": "SoftwareApplication",
"identifier": "leaflet",
"name": "leaflet",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=leaflet"
},
{
"@type": "SoftwareApplication",
"identifier": "tidyverse",
"name": "tidyverse",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=tidyverse"
},
{
"@type": "SoftwareApplication",
"identifier": "sf",
"name": "sf",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=sf"
},
{
"@type": "SoftwareApplication",
"identifier": "dplyr",
"name": "dplyr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=dplyr"
},
{
"@type": "SoftwareApplication",
"identifier": "scales",
"name": "scales",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=scales"
},
{
"@type": "SoftwareApplication",
"identifier": "ggplot2",
"name": "ggplot2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=ggplot2"
},
{
"@type": "SoftwareApplication",
"identifier": "readr",
"name": "readr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=readr"
},
{
"@type": "SoftwareApplication",
"identifier": "lubridate",
"name": "lubridate",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=lubridate"
},
{
"@type": "SoftwareApplication",
"identifier": "htmltools",
"name": "htmltools",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=htmltools"
},
{
"@type": "SoftwareApplication",
"identifier": "htmlwidgets",
"name": "htmlwidgets",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=htmlwidgets"
}
],
"softwareRequirements": {
"1": {
"@type": "SoftwareApplication",
"identifier": "httr",
"name": "httr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=httr"
},
"2": {
"@type": "SoftwareApplication",
"identifier": "curl",
"name": "curl",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=curl"
},
"3": {
"@type": "SoftwareApplication",
"identifier": "tibble",
"name": "tibble",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=tibble"
},
"4": {
"@type": "SoftwareApplication",
"identifier": "testthat",
"name": "testthat",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=testthat"
},
"5": {
"@type": "SoftwareApplication",
"identifier": "R.cache",
"name": "R.cache",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=R.cache"
},
"6": {
"@type": "SoftwareApplication",
"identifier": "utils",
"name": "utils"
},
"SystemRequirements": null
},
"fileSize": "111215.176KB",
"citation": [
{
"@type": "SoftwareSourceCode",
"datePublished": "2022",
"author": [
{
"@type": "Person",
"givenName": "Emmet",
"familyName": "Tam"
},
{
"@type": "Person",
"givenName": "Allison",
"familyName": "Reilly"
},
{
"@type": "Person",
"givenName": "Hamed",
"familyName": "Ghaedi"
},
{
"@type": "Person",
"givenName": "Shuyu",
"familyName": "Jin"
}
],
"name": "rhud: A R Interface for the HUD (US Department of Housing and Urban Development) APIs",
"url": "https://github.com/etam4260/rhud/",
"description": "0.3.0.9000"
},
{
"@type": "SoftwareSourceCode",
"datePublished": "2022",
"author": [
{
"@type": "Person",
"givenName": "Emmet",
"familyName": "Tam"
},
{
"@type": "Person",
"givenName": "Allison",
"familyName": "Reilly"
},
{
"@type": "Person",
"givenName": "Hamed",
"familyName": "Ghaedi"
},
{
"@type": "Person",
"givenName": "Shuyu",
"familyName": "Jin"
}
],
"name": "rhud: A R interface for accessing HUD (US Department of Housing and Urban Development) APIs",
"identifier": "10.5281/zenodo.6644503",
"url": "https://doi.org/10.5281/zenodo.6644503",
"description": "To cite package 'rhud' in publications use:",
"@id": "https://doi.org/10.5281/zenodo.6644503",
"sameAs": "https://doi.org/10.5281/zenodo.6644503"
}
],
"releaseNotes": "https://github.com/etam4260/rhud/blob/master/NEWS.md",
"readme": "https://github.com/etam4260/rhud/blob/main/README.md",
"contIntegration": [
"https://github.com/etam4260/rhud/actions",
"https://codecov.io/gh/etam4260/rhud?branch=main"
],
"developmentStatus": [
"https://www.repostatus.org/#active",
"https://www.tidyverse.org/lifecycle/#maturing"
],
"review": {
"@type": "Review",
"url": "https://github.com/ropensci/software-review/issues/524",
"provider": "https://ropensci.org"
},
"keywords": [
"hud",
"crosswalk",
"chas",
"api",
"income-limits",
"fair-markets-rent"
]
}
GitHub Events
Total
- Fork event: 1
Last Year
- Fork event: 1
Dependencies
DESCRIPTION
cran
- R.cache * imports
- curl * imports
- httr * imports
- testthat * imports
- tibble * imports
- utils * imports
- covr * suggests
- devtools * suggests
- dplyr * suggests
- ggplot2 * suggests
- htmltools * suggests
- htmlwidgets * suggests
- httptest * suggests
- knitr * suggests
- leaflet * suggests
- lubridate * suggests
- readr * suggests
- rmarkdown * suggests
- scales * suggests
- sf * suggests
- tidyverse * suggests
- tigris * suggests
.github/workflows/R-CMD-check.yaml
actions
- actions/checkout v2 composite
- actions/upload-artifact main composite
- r-lib/actions/check-r-package v1 composite
- r-lib/actions/setup-r v1 composite
- r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/test-coverage.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/setup-r v1 composite
- r-lib/actions/setup-r-dependencies v1 composite