cfpb / HMDA_Data_Science_Kit

Creative Commons Zero v1.0 Universal
41 stars 25 forks source link

Don't require HMDA_Data_Science_Kit to be directory name + README cleanup #53

Closed jsoma closed 5 years ago

jsoma commented 5 years ago

Thanks for providing this, it's a heck of a lot more useful than downloading the files one at a time and massaging them together!

If you download the zip of the repo instead of cloning it, your code will end up in a directory named HMDA_Data_Science_Kit-master. Running write_data_paths.sh would then fail to write correct paths to the SQL because it adjusts the path based on a specific number of characters. To fix this I adjusted the script + SQL to work even if the base directory isn't HMDA_Data_Science_Kit.

The path reset script has been adjusted to work with these changes.

I also fixed create_and_load_lar_2017.sql which had someone's personal path in it.

Finally, I cleaned up the README, adding leveled headers to help with accessibility + added a Quickstart at the bottom (it was easy to miss some of the steps in all of the text). Apologies that the documentation changes aren't in a separate PR.

Kibrael commented 5 years ago

Thank you for your contributions, @jsoma! We really appreciate it.