Project Report

(5 pts, due Mar 30)

You are highly encouraged to complete it all well in advance of the deadline. Only one member needs to submit the PDF of your report as well as the code into the Project Report Sakai assignment.

Your report is to provide a summary of what you have accomplished, without assuming someone has seen your presentation. This should resemble your proposal in structure (detailed below), but clearly indicate specifically what your group has accomplished. Page counts are not important, but an expectation between 3 and 6 pages, not counting code, is normal.

Project Name, Participants, and Work flow

Give the project a good name, and include emails and roles of participants in as much detail as possible. Document how you worked collaboratively on the project.

Project Abstract

Include 1-3 paragraphs explaining your project. This abstract should focus on the goal of the project from a user’s perspective rather than the underlying implementation methods you will use.

Project Design

Discuss any important design decisions in your program. List the most important functions and/or methods in your project and an idea of how the coding was completed. Describe in detail the functionality of your program as seen by the user. If there was complicated logic in a particular function, you are expected to describe it here. There MUST BE SCREEN SHOTS of every important portion of your project. The reader should be able to have a clear understanding of what your program does.

Project Milestones

List concrete milestones reached throughout the project. Identify incremental features added.

Reference Material

Every outside source of code should be documented. Also mention if significant portions of your code where "inspired" by someone else’s code. If there is ever a question, it is always better to reference what you use.

Project Code

The code of your project will be inspected. Although we haven’t covered programming style in depth, a reasonable design, good names for functions and variables, and basic legibility is expected. Again, if you have copied significant portions of code from other sources, indicated directly in the code where it comes from, including web pages if available.

• Provide a PDF of all of the code that has been written by your group, and include it in the report. Singly-spaced 10pt font is preferred.
• Also submit via Sakai with the code in the same way you ran it (e.g. files with a .ipynb or .R extensions, and any necessary data files). Enough code should be submitted to allow whoever receives the code to run your program.