Milestone 1 Issues

[aimirza]

You may close this issue when all issues are resolved and checked.

Mechanics

• [x] In your main README.md, provide a short description of what each script does including its outputs. Your explanation could include a flow chart/dependecy diagram.
• [x] Describe the type of variables (e.g., categorical, ordinal, numeric, etc).
• [x] You didn't train the ML model on the test set did you? Its a bit odd that your model had a better accuracy score for the test set than the training set.

Reasoning

• [x] You didn't explain why you decided to train your model on the respected features.

Visualization

• [x] You displayed no figures, only tables in the report...
• [x] Its a good practice to plot a line graph of the cross-validation scores and tree depth so that the reader can visualize why you selected the respective tree depth and to assess over-fitting.
• [x] It is also a good idea to visualize the decision tree to understand how the model works.

Quality -- Readability and Documentation

• [x] Make your model reproducible. See this.

Quality -- Robustness and Maintainability

• [x] Should have a unit test for each function (other than the main function)

Grammar and Spelling Report: Misspelled: moment, designated, frequencies, during, quantitatively, adequately,

[aimirza]

Still several past issues not addressed. I wish you responded to my comments. I totally missed that you had figures after the references.

• [x] Please move some of the figures in between the text, not after references.
• [x] You created results/figure/decision_tree.png but it is not incorporated into the report. You talked about the decision tree though the figure is not present in the report.
• [x] Makefile is hard to read because of all the long paths

[tungpatrick]

We have updated all the issues you have provided feedback on. Thank you very much.