Project Report Template
Create your project report in a file called REPORT.md in your project repository. Use the following template. Substitute everything within curly braces “{}” with your own content.
## Project Report
**Contributors**: {Team members' names}
**Date**: {Date report was finalized}
### 1. The Data
{
- List the source of the dataset your team project will use:
- full name as provided by the site where you've found the dataset
- URL link of the site/page where the dataset is fully described.
- Briefly describe the dataset.
- Create the following sections and provide as much information you can find about the data set.
}
#### 1.1 Dataset Overview
{See the **Aether Data Documentation Template** to understand the criteria you'll use in your description.
Include information about the following:
- **Basics**, such as dataset name, owner/manager contact information, date of last update
- **Dataset content**
- what items (e.g., disease, person, device, etc.) and what attributes (e.g., age, price, etc.)
- how many records/items, how many attributes
- what timeframe the dataset cover
- size of the original file, size of the file used in the project
- **Intended use/purpose** of the dataset
}
#### 1.2 Dataset Details
{Include information about the following
- **Data collection procedurese**: How was the data collected? Who collected the data and how?
- **Representation**: Given its intended use or purpose, how representative is the dataset?
- **Data quality and pre-processing**:
- Is there missing information
- Is data out of date?
- Does it need pre-processing or cleaning? If yes, describe.
- **Privacy**:
- Is is possible to identify individuals?
- Does it contain *sensitive data* (e.g., personal info, business info, that could cause harm/damage if given access to)?
- Are there potential *data confidentiality* issues (e.g., disclosure of non-public or sensitive data)
}
Divide work equally and include authorship information for content that each student has written in the **1.1 Data section**.
### 2. The Questions
- Write FOUR questions (two for each team member) that:
- Guide your project work
- Give interesting insights into the dataset.
- For each question:
- Indicate the dataset field(s) involved in your question.
- Describe how the data in the selected fields relate to each other.
- What other characteristics of the data would provide additional insights into the question
Divide work equally and include authorship information for content that each student has written in this section.
### 3. The Solution
{
To present the solution to each question, use the subheadings below to:
- Succintly and clearly explain the logical steps of the transformation.
- Use a simple example to support your explanation.
}
#### 3.1 Question 1
#### 3.2 Question 2
#### 3.3 Question 3
#### 3.4 Question 4
Divide work equally and include authorship information for content that each student has written in this section.
### 4. Test Cases
{
- Describe the test cases that demonstrate the correctness of the solution.
- Make sure that testing covers all the methods in the implementation of the program.
- Use subheadings (level ####) to organize this section
- Name and describe the testing modules for which EACH team member was responsible
- For each testing module (corresponding to a method), name and descrtibe each testing function
- Testing funcion name should be suggestive of the type of test.
- Each test describes specific inputs and expected results.
- Describe the **alternative ways of getting and testing the results** (e.g., manually using Excel)
- Name the testing files (if used) appropriately
}
Divide work equally and include authorship information for content that each student has written in this section.
### 5. Results and Discussion
{
Describe the investigative quesitons' results.
- What do the results show?
- What do the results mean?
- What can be interpreted from the results?
- Any discoveries or insights your team has gained from the results?
}
Divide work equally and include authorship information for content that each student has written in this section.
### 6. Reflection
#### 6.1 Challenges
{Each team member answers the question:
- What was the most challenging part of the project?
}
#### 6.2 Successes
{Each team member answers the question:
- Which part of the project went really well?
}
#### 6.3 Lessons leanred
{Each team member answers the question:
- What is the most valuable lesson learned through the project?
}