Due: Monday 11/08, no late period
General Directions
The prototype deliverable is intended to demonstrate a proof of concept for your final project report. Large multi-week projects are challenging, this deliverable is intended to provide additional structure to ensure you are making progress and on a path towards success. It consists of a written report detailed below along with any accompanying data, code, or other supplementary resources that demonstrate your progress so far in the project. You can think of it as a rough draft for your final project. The report should stand on its own so that it makes sense to someone who has not read your proposal.
The report should contain at least three parts, which we define below. In terms of length, it should be about 3-4 pages using standard margins (1 in.), font (11-12 pt), and line spacing (1-1.5). A typical submission is around 2-3 pages of text and 3-4 pages overall with tables and figures. You should convert your written report to a pdf and upload it to Gradescope under the assignment “Project Prototype” by the due date. Be sure to include your names and NetIDs in your final document and use the group submission feature on Gradescope. You do not need to upload your accompanying data, code, or other supplemental resources demonstrating your work to Gradescope; instead, your report should contain instructions on how to access these resources (see part 2 below for more details).
Part 1: Introduction and Research Questions
Your prototype report should begin by reintroducing your topic and restating your research question(s) as in your proposal. Your research question(s) should be (1) substantial, (2) feasible, and (3) relevant. Briefly justify each of these points as in the project proposal. You can start with the text from your proposal, but you should update your introduction and research questions to reflect changes in or refinements of the project vision. Specifically, point out what has changed since the proposal. Your introduction should be sufficient to provide context for the rest of your report.
Part 2: Data Sources
After your introduction and research questions, your prototype should discuss the data you have collected and are using to answer your research questions. Be specific: name the datasets you are using and where they were collected from / how they were prepared. Briefly justify why your data are appropriate and sufficient to address your research questions. As in the introduction, you can begin with the text from your proposal but be sure to update it to fit with your evolving project.
Part 3: Preliminary Results and Methods
The preliminary results section of your report should summarize the results obtained so far in the project. Where possible, results should be summarized using clearly labeled tables or figures and supplemented with a written explanation of the significance of the results with respect to the research questions outlined in the previous section. Your results do not need to be final or conclusive for your entire project but should demonstrate substantial effort and progress and should provide concrete proof of concept or initial analysis with respect to your research questions.
Your results should be specific about exactly what data were used and how the results were generated. For example, if you scraped multiple web databases, merged them, and created a visualization, then you should explain how each step was conducted in enough detail that an informed reader could reasonably be expected to reproduce your results with time and effort. Just saying “we cleaned the data and dealt with missing values” is not sufficient detail, for example.
Your report itself should include an explanation of your methods, but it should also contain instructions on how to access your full implementation (that is, your code, data, and any other supplemental resources like additional charts or tables). The simplest way to do so is to include a link to the box folder, GitLab repo, or whatever other platform your group is using to house your data and code.
Part 4: Reflection and Next Steps
In this part, you should begin by reflecting on the progress of your project so far. Address the following:
- What has been successful in the project so far or what is essentially complete and ready for the final report?
- What has been challenging in the project so far or what is incomplete in the prototype that needs to be finished for the final report?
- What are your next steps? These should be concrete and specific actions that your group will take to address the challenges identified in order to complete a successful final project.
Feedback and Grading Rubric
Prototypes will be evaluated on the following criterion-based rubric. Prototypes satisfying all criteria will receive full credit. Formative feedback (comments and suggestions) will also be provided for each proposal by your project group mentor.
- Submits a relevant document satisfying general requirements
- Includes a brief introduction to the topic of interest
- Poses one or more concrete research questions
- Provides a reasonable justification that research questions are substantial
- Provides a reasonable justification that research questions are feasible
- Provides a reasonable justification that research questions are relevant
- Explains how the topic/research questions have (or have not) changed since the proposal
- Includes a discussion of concrete/specific data sources
- Provides reasonable justification that data sources are appropriate for research questions
- Provides some specific preliminary results in the form of analysis, tables, visualization, etc.
- Results demonstrate substantial effort and progress toward addressing research questions, do not have to be complete or exhaustive but must demonstrate effort and progress
- Methods used to obtain results are described in sufficient detail to understand and interpret results
- Provides a link/reference to additional materials (e.g., code and data stored in box or GitLab)
- Reflects on successes / what is fairly complete in the project so far
- Reflects on challenges / what is incomplete in the project so far
- Discusses concrete/specific action items to complete the final project