get_ZIP3_hpi: get ZIP3 HPI data
In xdderekchen/rEconEnv: Get Economic Environment data like historical Home Price Index data and Interest data.
Description
Usage
Arguments
Value
Examples
Description
get ZIP3 level Home Price Index data
Usage
1
get_ZIP3_hpi(zip3file = NULL, from_year = NULL, out.Monthly = TRUE)
Arguments
zip3file
The filename for the data downloaded from "https://www.fhfa.gov/DataTools/Downloads/Documents/HPI/HPI_AT_3zip.xlsx". If this is null, the function will connect to the download site.
from_year
Four digits representing the data starting year.
out.Monthly
TRUE means Monthly data, FASLE means Quarterly data.
Value
data in the data.table format with columns (ZIP3, Date, Index)
Examples
1
2
3
4
# get recent ZIP3 Home Price Index (monthly) since 2010
zip3hpi_m <- get_ZIP3_hpi(from_year=2010, out.Monthly=TRUE)
# get recent ZIP3 (US) Home Price Index (quarterly) since 2000
zip3hpi_Q <- get_ZIP3_hpi(from_year=2000, out.Monthly=FALSE)
xdderekchen/rEconEnv documentation built on Feb. 23, 2020, 7:55 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
Description
get ZIP3 level Home Price Index data
Usage
1 | get_ZIP3_hpi(zip3file = NULL, from_year = NULL, out.Monthly = TRUE)
|
Arguments
zip3file |
The filename for the data downloaded from "https://www.fhfa.gov/DataTools/Downloads/Documents/HPI/HPI_AT_3zip.xlsx". If this is null, the function will connect to the download site. |
from_year |
Four digits representing the data starting year. |
out.Monthly |
TRUE means Monthly data, FASLE means Quarterly data. |
Value
data in the data.table format with columns (ZIP3, Date, Index)
Examples
1 2 3 4 | # get recent ZIP3 Home Price Index (monthly) since 2010
zip3hpi_m <- get_ZIP3_hpi(from_year=2010, out.Monthly=TRUE)
# get recent ZIP3 (US) Home Price Index (quarterly) since 2000
zip3hpi_Q <- get_ZIP3_hpi(from_year=2000, out.Monthly=FALSE)
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.