Update README.md

README.md

@@ -138,8 +138,9 @@ as it primarily contains permit-related data.
 
 ## Dataset Structure
 
-The cleaned and modified full dataset[`Building_Permits_Cleaned.csv`], the splited train[`housing_train_dataset.csv`] and test[`housing_test_dataset.csv`] dataset, 
-and the script to achieve that are provided in the following Github Repo: [https://github.com/HathawayLiu/Housing_dataset]
+The cleaned and modified full dataset[`Building_Permits_Cleaned.csv`], the splited train[`housing_train_dataset.csv`] and test[`housing_test_dataset.csv`] dataset 
+are provided in the following Github Repo: [https://github.com/HathawayLiu/Housing_dataset]. The cleaned train and test dataset are also provided in the **`data`**
+folder of this repo.
 
 The cleaned dataset in total contains 26 columns:
 - **`PermitNum`(string):** The tracking number used to refer to this permit in SDCI's tracking system.
@@ -178,15 +179,22 @@ Regarding the importance fo 13 neighborhood districts in Seattle, the new added
 to investigate the building activities and life quality in the aspect of different neighborhood districts.
 The dataset supports the city's commitment to open data and the promotion of data-driven insights for improving urban infrastructure and living conditions.
 
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
 
 #### Data Collection and Processing
 
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
+The Building Permits dataset is collected by Seattle Government where it contains all of the recent information about housing permits in Seattle. The dataset is published on
+Seattle Government Open Data Portal and it's keep updating along with time. You can download the raw data from [Seattle Government Website](https://data.seattle.gov/Permitting/Building-Permits/76t5-zqzr/about_data)
+in different formats. For my own purpose I downloaded the CSV version that updated until the modified time of this repo and you can find it in the following Github Repo:[https://github.com/HathawayLiu/Housing_dataset]
+(which is the same as the one I mentioned above). To process and clean the dataset, I did the following steps:
+1. Pre-process the data to make sure that they are in the correct types.
+2. Use the provided `latitude` and `longitude` columns in the dataset along with Google Maps API to fill in the blanks for the `OriginalZip`(Zip code) column.
+3. Use the provided `latitude` and `longitude` columns and the GeoJSon file of Seattle Neighborhood District to assign building permits to their corresponding neighborhood districts.
+4. (The GeoJSon file of Seattle Neighborhood District could be found under this GitHub Repo:[https://github.com/HathawayLiu/Housing_dataset]. You could also download it through Seattle GeoData Portal:https://data-seattlecitygis.opendata.arcgis.com/datasets/SeattleCityGIS::neighborhood-map-atlas-districts/about)
+5. Fill in the blanks left in the dataset with `N/A` for easier future use
+6. Split the dataset into train and test set for future use.
+
+For more details about data cleaning and processing, you could refer to the `data_cleaning.py` file under this repo. You are more than welcome to download the raw
+data and process the dataset yourself.
 
 #### Who are the source data producers?