https://github.com/topepo/AmesHousing

Ames IA Housing data from De Cock (2011)
https://github.com/topepo/AmesHousing

Last synced: 3 months ago
JSON representation

Ames IA Housing data from De Cock (2011)

• Host: GitHub
• URL: https://github.com/topepo/AmesHousing
• Owner: topepo
• Created: 2017-09-10T19:05:16.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-21T15:56:58.000Z (almost 2 years ago)
• Last Synced: 2024-06-20T19:28:27.283Z (5 months ago)
• Language: R
• Size: 524 KB
• Stars: 13
• Watchers: 3
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AmesHousing

[![R build status](https://github.com/topepo/AmesHousing/workflows/R-CMD-check/badge.svg)](https://github.com/topepo/AmesHousing/actions)

[![Codecov test coverage](https://codecov.io/gh/topepo/AmesHousing/branch/master/graph/badge.svg)](https://codecov.io/gh/topepo/AmesHousing?branch=master)

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/AmesHousing)](http://CRAN.R-project.org/package=AmesHousing)

[![Downloads](http://cranlogs.r-pkg.org/badges/AmesHousing)](https://CRAN.R-project.org/package=AmesHousing)

![](https://img.shields.io/badge/lifecycle-maturing-blue.svg)

This package contains the data described by [De Cock (2011)](http://ww2.amstat.org/publications/jse/v19n3/decock.pdf) where 82 fields were recored for 2,930 properties in Ames IA. Different versions of the data are available using the package. 

## Installation

To install the package from CRAN, use

```r

install.packages("AmesHousing")

```

You can install the development version of `AmesHousing` from GitHub with:

``` r

# install.packages("devtools")

devtools::install_github("topepo/AmesHousing")

```

## Details

* Using `data(ames_raw)`, a tibble is attached with the data as it is found on the website. 

* Using the command, `make_ames()` a tibble is returned that has a processed version of the data (see notes below). 

* The command `make_ordered_ames()` returns a similar tibble but several of the variables are formatted as ordered factors. 

## The Processed Version

The exact details can be found in the code of `make_ames` but a summary is:

 * All factors are _unordered_.

 * `PID` and `Order` are removed. 

 * Spaces and special characters in column names where changed to snake case. To be consistent, `SalePrice` was changed to `Sale_Price`. 

 * One row was removed with an unexplained missing value. 

 * Many factor levels were changed to be more understandable (e.g. `Split_or_Multilevel` instead of `080`)

 * Many missing values were reset. For example, if the variable `Bsmt_Qual` was missing, this implies that there is no basement on the property. Instead of a missing value, the value of `Bsmt_Qual` was changed to `No_Basement`. Similarly, numeric data pertaining to basements were set to zero where appropriate such as variables `Bsmt_Full_Bath` and `Total_Bsmt_SF`.

* `Garage_Yr_Blt` contained 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. 

## The Ordered Factor Version

`make_ordinal_ames` is the same as `make_ames` but many ordinal data were changed to class `ordered`.