P1: Data Collection
For this phase of the project, you should implement the data collection plan you proposed in P0, taking into account any feedback I provided.
Any data that you indicated would be collected "one-off" in your proposal should be completed by the time P1 is due. Any data that is set to be collected on an ongoing basis should at least be started and include at least one iteration of results.
What to turn in
- Code for data collection
- Data that has been collected
- Code for writing derivative data
- Derivative data constructed for further analysis (.csv files)
- Document explaining the code and data
Place everything in your team account's ~/qtw/ directory. Place the code in ~/qtw/code/p1/ and the data in ~/qtw/data/p1/. After completing the assignment, place another copy of your code and data in the ~/qtw/code/p2/ and ~/qtw/data/p2/ directories, respectively. After submitting P1, you should not modify any code or data in the p1 directories. If you do decide to make further tweaks to your code or data while working on P2, do so on the versions placed in the p2 directories. You do not need to copy over raw files that you have downloaded that will not change.
In addition to the code and data, please include a file called P1_documentation.pdf located in the ~/qtw/code/ directory. Include an explanation of your code and data. Write the document so that I can learn everything I need to know in order to understand what has been included in your data collection. This includes providing a brief (at most 1 paragraph) description of each code file included. You should also generate a pydoc file for each Python file, so I can easily read descriptions of the methods.
For each flat file or pickle file included in the data directory, briefly explain in P1_documentation.pdf what is included (field names plus an example entry). For those of you using MongoDB, please list every collection created and include a description of the fields and an example entry.
Finally, include a "Changes" section in the document, where you briefly list in bullet form all deviations from the project proposal document P0. If you left any design decisions unresolved in P0 because you weren't sure what to do, please list here what you ultimately did.