CMSE 495
Michigan State University Data Science Capstone.
Figure Reproducibility initial documentation
Agenda (80 Minutes)
- (50 minutes) Figure Reviews
- (25 minutes) Group meeting
Figure Reviews
This is a tri-pod team paring exercise. Your team will work with another team to review your figure generation. Combine your teams and split up in to two groups (some people from each team). Have one group review your teams installation and figure instructions and the other group review the other teams instructions. This should feel very similar to what we did a few weeks ago, you can just repeat the review. Hopefully things have been updated based on previous feedback and now are working better.
| Tripod V2 | Team A | Team B | Team C |
|---|---|---|---|
| 1 | CEPI | HFH_MT | HAP |
| 2 | Documenters | MSU_HC | HFH_RC |
| 3 | HFH_QC | HFH_PP | Grassroots |
| 4 | MSU_JO | MSU_WD | MSU_GR |
| 5 | TechSmith | TwoSix | QSIDE |
Agenda
- (5 minutes) Break up into tripod groups. Split people up so that there are members of each team in each tripod group.
- (5 minutes) Quick Introductions. Identify a timekeeper, notetaker, code reviewer, and facilitator.
- (20 minutes) Review Installation and Figure instructions
- (10 minutes) Discussion and brainstorming about improvements
- (10 minutes) Finish typing up email to instructors
In your group, have someone that is not from the code development team to try to install the software and review the figure instructions. Have the group members from the development team hold back and only give advice and support if there is a problem. The idea is to streamline the process so that the figure instructions are sufficient for someone outside of the development team to be able to reproduce the figure (within reason) without needing to have a developer to help. As a group take lots of notes and review the documentation to the development group some constructive feedback. If you are a member of the code’s development team, use this as an opportunity to fix problems as they are discovered.
As a group, prepare a report for the instructor and the development team. This report should provide the following:
- List of the evaluation group members with an indication about which capstone team they are on.
- Was someone outside the development team able to understand and possibly reproduce the figure? If not, what was the problem?
- What are the open loops still on the project?
- Is there anything that needed to be added to the code/instructions to make the project easier to understand?
- Was there anything you could add to the project to help make the project better?
This is a group effort, use the attached google document to submit the report to the instructors.
Group meeting
Conduct a group meeting for the remainder of the hour. Check your project milestones, progress and make plans to practice and finish your presentation by next week.
Written by Dr. Dirk Colbry, Michigan State University
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.