peer review

[nehamenon704]

• At first, it is unclear why there is an src folder in the scripts folder. Perhaps could have 1 src folder in the root with an analysis-scripts and a functions folder to add clarity to project organization.
• Please include a list of dependencies in the README.md, including Docker Desktop!
• At first, I was unable to run your analysis when I ran the command $ docker-compose run --rm final-analysis-env make clean. It turns out that I forgot to start up Docker Desktop before running the command, which is why I ran into the issue! You may want to include that as a step in the Usage section of your README.md.
• It is quite hard to read the axis labels of Figure 1. It would be nice if the image was bigger or if the graphs used a bigger font!
• I like how you guys have documentation for each test in test_cleaning_data.py, test_eda.py, test_impute_split.py, and test_linear_regression.py. It would be really nice to do the same for each test in test_datareading.py!
• I also like your NumPy style docstrings for create_scatter_plots() and impute_split(). They provide valuable information about those functions. It may be extra helpful if some examples were added in the docstrings!
• The functions clean_data(), reading_data(), split_xy_columns(), and plot_rmse() would benefit from NumPy style docstrings too!
• I noticed that there is some commented-out code in scripts/eda.py and scripts/readingdata.py. If it's not needed, you could remove it to improve the 'cleanliness' of the code!
• Create a directory for your test data as it seems cluttered with everything under the test directory.
• Change some of your file names to represent more accurately what they represent. (Ex. WDICSV) Or fix them to correctly follow conventional file names (Ex. functionread.py -> functionRead.py, readingdata.py -> readingData.py etc..)
• This is minor but make sure your CONTRIBUTING.MD is much more detailed, take the template contributing file as an example, it is much more vast and lists specific contact methods to address issues.
• PDF rendering
• Figure 1 title
• Table 1 rendering
• Concise docker file

[nehamenon704]

• At first, it is unclear why there is an src folder in the scripts folder. Perhaps could have 1 src folder in the root with an analysis-scripts and a functions folder to add clarity to project organization.
• Please include a list of dependencies in the README.md, including Docker Desktop!
• At first, I was unable to run your analysis when I ran the command $ docker-compose run --rm final-analysis-env make clean. It turns out that I forgot to start up Docker Desktop before running the command, which is why I ran into the issue! You may want to include that as a step in the Usage section of your README.md.
• I like how you guys have documentation for each test in test_cleaning_data.py, test_eda.py, test_impute_split.py, and test_linear_regression.py. It would be really nice to do the same for each test in test_datareading.py!
• I also like your NumPy style docstrings for create_scatter_plots() and impute_split(). They provide valuable information about those functions. It may be extra helpful if some examples were added in the docstrings!
• Concise docker file

[cadenmchan]

• This is minor but make sure your CONTRIBUTING.MD is much more detailed, take the template contributing file as an example, it is much more vast and lists specific contact methods to address issues.
• Create a directory for your test data as it seems cluttered with everything under the test directory.
• At first, I was unable to run your analysis when I ran the command $ docker-compose run --rm final-analysis-env make clean. It turns out that I forgot to start up Docker Desktop before running the command, which is why I ran into the issue! You may want to include that as a step in the Usage section of your README.md.
• I like how you guys have documentation for each test in test_cleaning_data.py, test_eda.py, test_impute_split.py, and test_linear_regression.py. It would be really nice to do the same for each test in test_datareading.py!
• I also like your NumPy style docstrings for create_scatter_plots() and impute_split(). They provide valuable information about those functions. It may be extra helpful if some examples were added in the docstrings!
• The functions clean_data(), reading_data(), split_xy_columns(), and plot_rmse() would benefit from NumPy style docstrings too!
• I noticed that there is some commented-out code in scripts/eda.py and scripts/readingdata.py. If it's not needed, you could remove it to improve the 'cleanliness' of the code!

[tak4563]

This is minor but make sure your CONTRIBUTING.MD is much more detailed, take the template contributing file as an example, it is much more vast and lists specific contact methods to address issues. PDF rendering Figure 1 title Table 1 rendering

[petercmh01]

• I noticed that there is some commented-out code in scripts/eda.py and scripts/readingdata.py. If it's not needed, you could remove it to improve the 'cleanliness' of the code!
• It is quite hard to read the axis labels of Figure 1. It would be nice if the image was bigger or if the graphs used a bigger font!
• Change some of your file names to represent more accurately what they represent. (Ex. WDICSV) Or fix them to correctly follow conventional file names (Ex. functionread.py -> functionRead.py, readingdata.py -> readingData.py etc..)

edit: I think I just finished them