Project Review Template

Author

YOUR NAME

Published

Invalid Date

Modified

2023-12-31

1 Overview

Title of project:

Name of project author(s):

Name of project reviewer:

2 Instructions

Write your comments and feedback below for each section/component of the project. The goal should be to help the author improve their project. Make comments as constructive and actionable as possible. You can provide both criticism and praise.

For each component, pick one summary statement by deleting the ones that do not apply and keeping only the one that you think most closely summarizes a given component.

Make sure your final document compiles/knits into a readable, well-formatted html document.

Delete any sections/text of this template that are not part of your final review document. (Including these instructions.)

3 Specific project content evaluation

Evaluate the different parts of the project by filling in the sections below.

3.1 Background, Context and Motivation

How well is the context of the project described? Is a comprehensive background, including summary of previous/related work given? Is the project well placed into the context of existing work (including proper referencing of existing work). Is it clear why the project was undertaken and what new information it hopes to provide?

3.1.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

3.1.2 Summary assessment (PICK ONE, DELETE THE OTHERS)

  • very poor contextualization and motivation
  • some contextualization and motivation
  • strong contextualization and motivation

3.2 Question description

How well and clear are the question(s)/hypotheses the project aims to address described? Is it clear how the questions relate to the data?

3.2.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

3.2.2 Summary assessment

  • question/hypotheses unclear
  • question/hypotheses somewhat explained
  • question/hypotheses fully clear

3.3 Data description

How well is the data overall described? Is the source provided? Is a codebook or other meta-information available that makes it clear what the data is?

3.3.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

3.3.2 Summary assessment

  • source and overall structure of data poorly explained
  • source and overall structure of data somewhat explained
  • source and overall structure of data well explained

3.4 Data wrangling and exploratory analysis

How well is the data cleaned/processed and explored? Are all steps reasonable and well explained? Are alternatives discussed and considered? Are meaningful exploratory results shown (e.g. in the supplementary materials)?

3.4.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

3.4.2 Summary assessment

  • major weaknesses in wrangling and exploratory component
  • some weaknesses in wrangling and exploratory component
  • essentially no weaknesses in wrangling and exploratory component

3.5 Appropriateness of Analysis

Were the analysis methods appropriate for the data? Was the analysis done properly? Were different components of the analysis (e.g. performance measure, variable selection, data pre-processing, model evaluation) done in the best way possible and explained well?

3.5.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

3.5.2 Summary assessment

  • wrong/inadequate analysis
  • defensible but not optimal analysis
  • strong and reasonable analysis

3.6 Presentation

How well are results presented? Are tables and figures easy to read and understand? Are the main figures/tables publication level quality?

3.6.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

3.6.2 Summary assessment

  • results are poorly presented, hard to understand, poor quality
  • results are presented ok, with room for improvement
  • results are very well presented

3.7 Discussion/Conclusions

Are the study findings properly discussed? Are strengths and limitations acknowledged? Are findings interpreted properly?

3.7.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

3.7.2 Summary assessment

  • major parts of discussion missing or wrong
  • minor parts wrong, missing or unclear
  • strong, complete and clear discussion

3.8 Further comments

Add any other comments regarding the different aspects of the project here. Write anything you think can help your classmate improve their project.

4 Overall project content evaluation

Evaluate overall features of the project by filling in the sections below.

4.1 Structure

Is the project well structured? Are files in well labeled folders? Do files have reasonable names? Are all “junk” files not needed for analysis/reproduction removed? By just looking at files and folders, can you get an idea of how things fit together?

4.1.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

4.1.2 Summary assessment

  • poor and confusing structure
  • mostly clear, but some confusing parts (e.g. useless files, things in the wrong folders)
  • well structured

4.2 Documentation

How well is the project documented? Are you able to understand each step of the whole analysis, each decision that was made, and each line of code? Is enough information provided as comments in code or as part of Rmd files?

4.2.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

4.2.2 Summary assessment

  • poorly documented
  • decently documented with some gaps
  • fully and well documented

4.3 Reproducibility

Are all results fully reproducible? Is documentation provided which clearly explains how to reproduce things, and does it work without the need for any manual intervention? Are you able to re-run the whole analysis without having to do manual interventions/edits?

4.3.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

4.3.2 Summary assessment

  • major parts not reproducible
  • small parts not reproducible or required manual intervention
  • fully reproducible without issues

4.4 Thoroughness

How thorough was the overall study? Were alternatives (e.g. different ways of processing the data or different models) considered? Were alternatives discussed? Were the questions/hypotheses fully and thoroughly addressed?

4.4.1 Feedback and Comments

WRITE YOUR FEEDBACK HERE

4.4.2 Summary assessment

  • weak level of thoroughness
  • decent level of thoroughness
  • strong level of thorougness

4.5 Further comments

Add any other comments regarding the overall project here. Write anything you think can help your classmate improve their project.