Help for package AmesHousing (original) (raw)
| Version: | 0.0.4 |
|---|---|
| Title: | The Ames Iowa Housing Data |
| URL: | https://github.com/topepo/AmesHousing |
| BugReports: | https://github.com/topepo/AmesHousing/issues |
| Description: | Raw and processed versions of the data from De Cock (2011) http://ww2.amstat.org/publications/jse are included in the package. |
| License: | GPL-2 |
| Encoding: | UTF-8 |
| LazyData: | true |
| ByteCompile: | true |
| Depends: | R (≥ 2.10) |
| Imports: | dplyr, magrittr |
| RoxygenNote: | 7.1.0.9000 |
| Suggests: | covr |
| NeedsCompilation: | no |
| Packaged: | 2020-06-23 19:56:43 UTC; max |
| Author: | Max Kuhn [aut, cre], Dmytro Perepolkin [ctb], RStudio [cph] |
| Maintainer: | Max Kuhn max@rstudio.com |
| Repository: | CRAN |
| Date/Publication: | 2020-06-23 20:10:03 UTC |
Raw Ames Housing Data
Description
Summon the data described by De Cock (2011) where 82 fields were recored for 2,930 properties in Ames IA.
Details
From the data documentation reference, the columns include:
Order: Observation numberPID: Parcel identification number - can be used with city web site for parcel review.MS SubClass: Identifies the type of dwelling involved in the sale.MS Zoning: Identifies the general zoning classification of the sale.Lot Frontage: Linear feet of street connected to propertyLot Area: Lot size in square feetStreet: Type of road access to propertyAlley: Type of alley access to propertyLot Shape: General shape of propertyLand Contour: Flatness of the propertyUtilities: Type of utilities availableLot Config: Lot configurationLand Slope: Slope of propertyNeighborhood: Physical locations within Ames city limits (map available)Condition 1: Proximity to various conditionsCondition 2: Proximity to various conditions (if more than one is present)Bldg Type: Type of dwellingHouse Style: Style of dwellingOverall Qual: Rates the overall material and finish of the houseOverall Cond: Rates the overall condition of the houseYear Built: Original construction dateYear Remod/Add: Remodel date (same as construction date if no remodeling or additions)Roof Style: Type of roofRoof Matl: Roof materialExterior 1: Exterior covering on houseExterior 2: Exterior covering on house (if more than one material)Mas Vnr Type: Masonry veneer typeMas Vnr Area: Masonry veneer area in square feetExter Qual: Evaluates the quality of the material on the exteriorExter Cond: Evaluates the present condition of the material on the exteriorFoundation: Type of foundationBsmt Qual: Evaluates the height of the basementBsmt Cond: Evaluates the general condition of the basementBsmt Exposure: Refers to walkout or garden level wallsBsmtFin Type 1: Rating of basement finished areaBsmtFin SF 1: Type 1 finished square feetBsmtFinType 2: Rating of basement finished area (if multiple types)BsmtFin SF 2: Type 2 finished square feetBsmt Unf SF: Unfinished square feet of basement areaTotal Bsmt SF: Total square feet of basement areaHeating: Type of heatingHeatingQC: Heating quality and conditionCentral Air: Central air conditioningElectrical: Electrical system1st Flr SF: First Floor square feet2nd Flr SF: Second floor square feetLow Qual Fin SF: Low quality finished square feet (all floors)Gr Liv Area: Above grade (ground) living area square feetBsmt Full Bath: Basement full bathroomsBsmt Half Bath: Basement half bathroomsFull Bath: Full bathrooms above gradeHalf Bath: Half baths above gradeBedroom: Bedrooms above grade (does NOT include basement bedrooms)Kitchen: Kitchens above gradeKitchenQual: Kitchen qualityTotRmsAbvGrd: Total rooms above grade (does not include bathrooms)Functional: Home functionality (Assume typical unless deductions are warranted)Fireplaces: Number of fireplacesFireplaceQu: Fireplace qualityGarage Type: Garage locationGarage Yr Blt: Year garage was builtGarage Finish: Interior finish of the garageGarage Cars: Size of garage in car capacityGarage Area: Size of garage in square feetGarage Qual: Garage qualityGarage Cond: Garage conditionPaved Drive: Paved drivewayWood Deck SF: Wood deck area in square feetOpen Porch SF: Open porch area in square feetEnclosed Porch: Enclosed porch area in square feet3-Ssn Porch: Three season porch area in square feetScreen Porch: Screen porch area in square feetPool Area: Pool area in square feetPool QC: Pool qualityFence: Fence qualityMisc Feature: Miscellaneous feature not covered in other categoriesMisc Val: $Value of miscellaneous featureMo Sold: Month SoldYr Sold: Year SoldSale Type: Type of saleSale Condition: Condition of sale
Value
Source
De Cock, D. (2011). "Ames, Iowa: Alternative to the Boston Housing Data as an End of Semester Regression Project," Journal of Statistics Education, Volume 19, Number 3.
https://ww2.amstat.org/publications/jse/v19n3/decock/DataDocumentation.txt
http://ww2.amstat.org/publications/jse/v19n3/decock.pdf
Ames Public Schools
Description
Locations of local schools and outline of elementary school districts. Elementary school district boundaries are returned as sf object in CRS 4326
Details
The data set includes the school name and the geocodes.
Value
| ames_schools_geo | a tibble |
|---|
Create a Processed Version of the Ames Housing Data
Description
Create a Processed Version of the Ames Housing Data
Usage
make_ames()
make_ames_new()
make_ordinal_ames()
Details
For the processed version, the exact details can be found in the code of make_ames but a summary of the differences between these data sets and ames_raw is:
- All factors are unordered.
PIDandOrderare removed.- Spaces and special characters in column names where changed to snake case. To be consistent,
SalePricewas changed toSale_Price. - Many factor levels were changed to be more understandable (e.g.
Split_or_Multilevelinstead of080) - Many missing values were reset. For example, if the variable
Bsmt_Qualwas missing, this implies that there is no basement on the property. Instead of a missing value, the value ofBsmt_Qualwas changed toNo_Basement. Similarly, numeric data pertaining to basements were set to zero where appropriate such as variablesBsmt_Full_BathandTotal_Bsmt_SF. Garage_Yr_Bltcontained many missing data and was removed.- Approximate longitude and latitude are included for the properties. Also, note that there are 6 properties with identical geotags. These are units within the same building. For some properties, updated versions of the PID identifiers were found and are replaced with new values.
make_ordinal_ames is the same as make_ames but many factor variables were changed to class ordered (see below).
The documentation for [ames_raw()](#topic+ames%5Fraw) contains descriptions of the columns although, as noted above, the column names in[ames_raw()](#topic+ames%5Fraw) are slightly different from the processed versions.
make_ames_new() creates a data set of new properties. These were populated using less data sources than the original and lack a number of the condition and quality. Both properties were unsold at the time of this writing.
Value
A tibble with the data.
Examples
ames <- make_ames()
nrow(ames)
summary(ames$Sale_Price)
ames_ord <- make_ordinal_ames()
ord_vars <- vapply(ames_ord, is.ordered, logical(1))
names(ord_vars)[ord_vars]
Objects exported from other packages
Description
These objects are imported from other packages. Follow the links below to see their documentation.
magrittr
[%>%](../../magrittr/refman/magrittr.html#topic+pipe)