Improve feature description

README.md

@@ -43,8 +43,8 @@ configs:
         Identifies the type of dwelling involved in the sale
   default: true
   sep: ","
-- config_name: metadata
-  data_files: "metadata.json"
+- config_name: features
+  data_files: "features.json"
 ---
 
 # Dataset Card for 'Ames Iowa: Alternative to the Boston Housing Data Set'
@@ -65,7 +65,7 @@ The dataset was originally published by Dean De Cock in [Ames, Iowa: Alternative
 - **Curated by:** Dean De Cock, Truman State University
 - **License:** Unknown
 
-Full description of the dataset is in [`./originals/DataDocumentation.txt`](./originals/DataDocumentation.txt), structured metadata was extracted manually in [`./metadata.json`](./metadata.json`).
+Full description of the dataset is in [`./originals/DataDocumentation.txt`](./originals/DataDocumentation.txt), structured metadata describing the features was extracted manually in [`./features.json`](./features.json`).
 
 The main dataset file is [`AmesHousing.csv`](./AmesHousing.csv) is the result of a simple preprocessing of the original file, the preprocessing script is in [`./preprocessing/preprocess.py`](preprocessing/preprocess.py).
 

metadata.json → features.json

@@ -1,14 +1,14 @@
 [
   {
-    "variable": "order",
-    "description": "Observation number",
+    "name": "order",
+    "description": "Observation number"
   },
   {
-    "variable": "pid",
-    "description": "Parcel identification number  - can be used with city web site for parcel review.",
+    "name": "pid",
+    "description": "Parcel identification number  - can be used with city web site for parcel review."
   },
   {
-    "variable": "ms_suclass",
+    "name": "ms_suclass",
     "description": "Identifies the type of dwelling involved in the sale.",
     "values":
       {
@@ -31,7 +31,7 @@
       }
   },
   {
-    "variable": "ms_zoning",
+    "name": "ms_zoning",
     "description": "Identifies the general zoning classification of the sale.",
     "values":
       {
@@ -46,22 +46,22 @@
       }
   },
   {
-    "variable": "lot_frontage",
+    "name": "lot_frontage",
     "description": "Linear feet of street connected to property"
   },
-  { "variable": "lot_area", "description": "Lot size in square feet" },
+  { "name": "lot_area", "description": "Lot size in square feet" },
   {
-    "variable": "street",
+    "name": "street",
     "description": "Type of road access to property",
     "values": { "Grvl": "Gravel", "Pave": "Paved" }
   },
   {
-    "variable": "alley",
+    "name": "alley",
     "description": "Type of alley access to property",
     "values": { "Grvl": "Gravel", "Pave": "Paved", "NA": "No alley access" }
   },
   {
-    "variable": "lot_shape",
+    "name": "lot_shape",
     "description": "General shape of property",
     "values":
       {
@@ -72,7 +72,7 @@
       }
   },
   {
-    "variable": "land_contour",
+    "name": "land_contour",
     "description": "Flatness of the property",
     "values":
       {
@@ -83,7 +83,7 @@
       }
   },
   {
-    "variable": "utilities",
+    "name": "utilities",
     "description": "Type of utilities available",
     "values":
       {
@@ -94,7 +94,7 @@
       }
   },
   {
-    "variable": "lot_config",
+    "name": "lot_config",
     "description": "Lot configuration",
     "values":
       {
@@ -106,13 +106,13 @@
       }
   },
   {
-    "variable": "land_slope",
+    "name": "land_slope",
     "description": "Slope of property",
     "values":
       { "Gtl": "Gentle slope", "Mod": "Moderate Slope", "Sev": "Severe Slope" }
   },
   {
-    "variable": "neighborhood",
+    "name": "neighborhood",
     "description": "Physical locations within Ames city limits",
     "values":
       {
@@ -144,7 +144,7 @@
       }
   },
   {
-    "variable": "condition_1",
+    "name": "condition_1",
     "description": "Proximity to various conditions",
     "values":
       {
@@ -160,7 +160,7 @@
       }
   },
   {
-    "variable": "condition_2",
+    "name": "condition_2",
     "description": "Proximity to various conditions (if more than one is present)",
     "values":
       {
@@ -176,7 +176,7 @@
       }
   },
   {
-    "variable": "bldg_type",
+    "name": "bldg_type",
     "description": "Type of dwelling",
     "values":
       {
@@ -188,7 +188,7 @@
       }
   },
   {
-    "variable": "house_style",
+    "name": "house_style",
     "description": "Style of dwelling",
     "values":
       {
@@ -203,7 +203,7 @@
       }
   },
   {
-    "variable": "overall_qual",
+    "name": "overall_qual",
     "description": "Rates the overall material and finish of the house",
     "values":
       {
@@ -220,7 +220,7 @@
       }
   },
   {
-    "variable": "overall_cond",
+    "name": "overall_cond",
     "description": "Rates the overall condition of the house",
     "values":
       {
@@ -236,13 +236,13 @@
         "10": "Very Excellent"
       }
   },
-  { "variable": "year_built", "description": "Original construction date" },
+  { "name": "year_built", "description": "Original construction date" },
   {
-    "variable": "year_remod_add",
+    "name": "year_remod_add",
     "description": "Remodel date (same as construction date if no remodeling or additions)"
   },
   {
-    "variable": "roof_style",
+    "name": "roof_style",
     "description": "Type of roof",
     "values":
       {
@@ -255,7 +255,7 @@
       }
   },
   {
-    "variable": "roof_matl",
+    "name": "roof_matl",
     "description": "Roof material",
     "values":
       {
@@ -270,7 +270,7 @@
       }
   },
   {
-    "variable": "exterior_1st",
+    "name": "exterior_1st",
     "description": "Exterior covering on house",
     "values":
       {
@@ -294,7 +294,7 @@
       }
   },
   {
-    "variable": "exterior_2nd",
+    "name": "exterior_2nd",
     "description": "Exterior covering on house (if more than one material)",
     "values":
       {
@@ -318,7 +318,7 @@
       }
   },
   {
-    "variable": "mas_vnr_type",
+    "name": "mas_vnr_type",
     "description": "Masonry veneer type",
     "values":
       {
@@ -330,11 +330,11 @@
       }
   },
   {
-    "variable": "mas_vnr_area",
+    "name": "mas_vnr_area",
     "description": "Masonry veneer area in square feet"
   },
   {
-    "variable": "exter_qual",
+    "name": "exter_qual",
     "description": "Evaluates the quality of the material on the exterior",
     "values":
       {
@@ -346,7 +346,7 @@
       }
   },
   {
-    "variable": "exter_cond",
+    "name": "exter_cond",
     "description": "Evaluates the present condition of the material on the exterior",
     "values":
       {
@@ -358,7 +358,7 @@
       }
   },
   {
-    "variable": "foundation",
+    "name": "foundation",
     "description": "Type of foundation",
     "values":
       {
@@ -371,7 +371,7 @@
       }
   },
   {
-    "variable": "bsmt_qual",
+    "name": "bsmt_qual",
     "description": "Evaluates the height of the basement",
     "values":
       {
@@ -384,7 +384,7 @@
       }
   },
   {
-    "variable": "bsmt_cond",
+    "name": "bsmt_cond",
     "description": "Evaluates the general condition of the basement",
     "values":
       {
@@ -397,7 +397,7 @@
       }
   },
   {
-    "variable": "bsmt_exposure",
+    "name": "bsmt_exposure",
     "description": "Refers to walkout or garden level walls",
     "values":
       {
@@ -409,7 +409,7 @@
       }
   },
   {
-    "variable": "bsmtfin_type_1",
+    "name": "bsmtfin_type_1",
     "description": "Rating of basement finished area",
     "values":
       {
@@ -422,9 +422,9 @@
         "NA": "No Basement"
       }
   },
-  { "variable": "bsmtfin_sf_1", "description": "Type 1 finished square feet" },
+  { "name": "bsmtfin_sf_1", "description": "Type 1 finished square feet" },
   {
-    "variable": "bsmtfin_type_2",
+    "name": "bsmtfin_type_2",
     "description": "Rating of basement finished area (if multiple types)",
     "values":
       {
@@ -437,17 +437,17 @@
         "NA": "No Basement"
       }
   },
-  { "variable": "bsmtfin_sf_2", "description": "Type 2 finished square feet" },
+  { "name": "bsmtfin_sf_2", "description": "Type 2 finished square feet" },
   {
-    "variable": "bsmt_unf_sf",
+    "name": "bsmt_unf_sf",
     "description": "Unfinished square feet of basement area"
   },
   {
-    "variable": "total_bsmt_sf",
+    "name": "total_bsmt_sf",
     "description": "Total square feet of basement area"
   },
   {
-    "variable": "heating",
+    "name": "heating",
     "description": "Type of heating",
     "values":
       {
@@ -460,7 +460,7 @@
       }
   },
   {
-    "variable": "heating_qc",
+    "name": "heating_qc",
     "description": "Heating quality and condition",
     "values":
       {
@@ -472,12 +472,12 @@
       }
   },
   {
-    "variable": "central_air",
+    "name": "central_air",
     "description": "Central air conditioning",
     "values": { "N": "No", "Y": "Yes" }
   },
   {
-    "variable": "electrical",
+    "name": "electrical",
     "description": "Electrical system",
     "values":
       {
@@ -488,27 +488,27 @@
         "Mix": "Mixed"
       }
   },
-  { "variable": "1st_flr_sf", "description": "First Floor square feet" },
-  { "variable": "2nd_flr_sf", "description": "Second floor square feet" },
+  { "name": "1st_flr_sf", "description": "First Floor square feet" },
+  { "name": "2nd_flr_sf", "description": "Second floor square feet" },
   {
-    "variable": "low_qual_fin_sf",
+    "name": "low_qual_fin_sf",
     "description": "Low quality finished square feet (all floors)"
   },
   {
-    "variable": "gr_liv_area",
+    "name": "gr_liv_area",
     "description": "Above grade (ground) living area square feet"
   },
-  { "variable": "bsmt_full_bath", "description": "Basement full bathrooms" },
-  { "variable": "bsmt_half_bath", "description": "Basement half bathrooms" },
-  { "variable": "full_bath", "description": "Full bathrooms above grade" },
-  { "variable": "half_bath", "description": "Half baths above grade" },
+  { "name": "bsmt_full_bath", "description": "Basement full bathrooms" },
+  { "name": "bsmt_half_bath", "description": "Basement half bathrooms" },
+  { "name": "full_bath", "description": "Full bathrooms above grade" },
+  { "name": "half_bath", "description": "Half baths above grade" },
   {
-    "variable": "bedroom_abvgr",
+    "name": "bedroom_abvgr",
     "description": "Bedrooms above grade (does NOT include basement bedrooms)"
   },
-  { "variable": "kitchen_abvgr", "description": "Kitchens above grade" },
+  { "name": "kitchen_abvgr", "description": "Kitchens above grade" },
   {
-    "variable": "kitchen_qual",
+    "name": "kitchen_qual",
     "description": "Kitchen quality",
     "values":
       {
@@ -520,11 +520,11 @@
       }
   },
   {
-    "variable": "totrms_abvgrd",
+    "name": "totrms_abvgrd",
     "description": "Total rooms above grade (does not include bathrooms)"
   },
   {
-    "variable": "functional",
+    "name": "functional",
     "description": "Home functionality (Assume typical unless deductions are warranted)",
     "values":
       {
@@ -538,9 +538,9 @@
         "Sal": "Salvage only"
       }
   },
-  { "variable": "fireplaces", "description": "Number of fireplaces" },
+  { "name": "fireplaces", "description": "Number of fireplaces" },
   {
-    "variable": "fireplace_qu",
+    "name": "fireplace_qu",
     "description": "Fireplace quality",
     "values":
       {
@@ -553,7 +553,7 @@
       }
   },
   {
-    "variable": "garage_type",
+    "name": "garage_type",
     "description": "Garage location",
     "values":
       {
@@ -566,9 +566,9 @@
         "NA": "No Garage"
       }
   },
-  { "variable": "garage_yr_blt", "description": "Year garage was built" },
+  { "name": "garage_yr_blt", "description": "Year garage was built" },
   {
-    "variable": "garage_finish",
+    "name": "garage_finish",
     "description": "Interior finish of the garage",
     "values":
       {
@@ -578,10 +578,10 @@
         "NA": "No Garage"
       }
   },
-  { "variable": "garage_cars", "description": "Size of garage in car capacity" },
-  { "variable": "garage_area", "description": "Size of garage in square feet" },
+  { "name": "garage_cars", "description": "Size of garage in car capacity" },
+  { "name": "garage_area", "description": "Size of garage in square feet" },
   {
-    "variable": "garage_qual",
+    "name": "garage_qual",
     "description": "Garage quality",
     "values":
       {
@@ -594,7 +594,7 @@
       }
   },
   {
-    "variable": "garage_cond",
+    "name": "garage_cond",
     "description": "Garage condition",
     "values":
       {
@@ -607,27 +607,27 @@
       }
   },
   {
-    "variable": "paved_drive",
+    "name": "paved_drive",
     "description": "Paved driveway",
     "values": { "Y": "Paved", "P": "Partial Pavement", "N": "Dirt/Gravel" }
   },
-  { "variable": "wood_deck_sf", "description": "Wood deck area in square feet" },
-  { "variable": "open_porch_sf", "description": "Open porch area in square feet" },
+  { "name": "wood_deck_sf", "description": "Wood deck area in square feet" },
+  { "name": "open_porch_sf", "description": "Open porch area in square feet" },
   {
-    "variable": "enclosed_porch",
+    "name": "enclosed_porch",
     "description": "Enclosed porch area in square feet"
   },
   {
-    "variable": "3ssn_porch",
+    "name": "3ssn_porch",
     "description": "Three season porch area in square feet"
   },
   {
-    "variable": "screen_porch",
+    "name": "screen_porch",
     "description": "Screen porch area in square feet"
   },
-  { "variable": "pool_area", "description": "Pool area in square feet" },
+  { "name": "pool_area", "description": "Pool area in square feet" },
   {
-    "variable": "pool_qc",
+    "name": "pool_qc",
     "description": "Pool quality",
     "values":
       {
@@ -639,7 +639,7 @@
       }
   },
   {
-    "variable": "fence",
+    "name": "fence",
     "description": "Fence quality",
     "values":
       {
@@ -651,7 +651,7 @@
       }
   },
   {
-    "variable": "misc_feature",
+    "name": "misc_feature",
     "description": "Miscellaneous feature not covered in other categories",
     "values":
       {
@@ -663,11 +663,11 @@
         "NA": "None"
       }
   },
-  { "variable": "misc_val", "description": "$Value of miscellaneous feature" },
-  { "variable": "mo_sold", "description": "Month Sold (MM)" },
-  { "variable": "yr_sold", "description": "Year Sold (YYYY)" },
+  { "name": "misc_val", "description": "$Value of miscellaneous feature" },
+  { "name": "mo_sold", "description": "Month Sold (MM)" },
+  { "name": "yr_sold", "description": "Year Sold (YYYY)" },
   {
-    "variable": "sale_type",
+    "name": "sale_type",
     "description": "Type of sale",
     "values":
       {
@@ -684,7 +684,7 @@
       }
   },
   {
-    "variable": "sale_condition",
+    "name": "sale_condition",
     "description": "Condition of sale",
     "values":
       {
@@ -697,7 +697,7 @@
       }
   },
   {
-    "variable": "saleprice",
+    "name": "saleprice",
     "description": "Sale price $$"
   }
 ]