CSC/ECE 517 Fall 2018/E1855 let course staff as well as users do reviews

From Expertiza_Wiki
Jump to navigation Jump to search

Introduction

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.


Problem Statement

The current system does not allow instructors to submit reviews of student work. We will work upon the feature which will let them review using the same review form that students use to do reviews.

Current scenario

This is how some of the pages we are concerned with, currently look.


Submissions page for an assignment in Instructor View


A typical Scores table in a Student View

Proposed Solutions and Implementation

Following changes will be made to let staff perform reviews as well:

Step 1: Add a way for the instructors to perform a review.

We are planning to implement links to Begin review, Edit review, View review and Submit review in the assignment submissions view. When the instructor/TA reviews a work for the first time, he/she is added as a participant and a review response mapping is created.

Files edited:

  • View: app/views/assignments/list_submissions.html.erb - To add links in the instructor view
  • Controller: app/controllers/review_mapping_controller.rb - Method: add_instructor_as_reviewer

In the second case, we can see a 'Begin review' link. This is the initial state when instructor review has not been added to the submission. Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear. If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. Similarly, just like students instructor would not able to edit or update the review.

Step 2: Add the instructor review in Your Scores table in case he has reviewed your work. Provide an icon to highlight the special nature of an instructors review.

Files edited:

  • Assets: app/assets/stylesheets/grades.scss - Icon to make an instructor's review distinct from other reviews
  • View: app/views/grades/view_team.html.erb - To modify the "Your scores" page to include an icon next to the peer review score indicating that the instructor's score is not included in the final peer review score.
  • Models:
    • app/models/answer.rb - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
    • app/models/vm_question_response_score_cell.rb - Included a new variable called 'is_instructor_review' to identify an instructor review
    • app/models/vm_question_response_row.rb - Change in average_score_for_row method to not include an instructor review score
    • app/models/vm_question_response.rb - Modified the add_answer method to include the is_instructor_review to each row_score object

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, there will be an icon next to the instructor's review along with explicitly stating that it is an 'Instructor review'. The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Test Plan

Features testing: Many of our changes are reflected on views (user interface). Following is the list of tests that we will conduct with rspec/capybara.

  1. it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
  2. it "should let instructor/TAs save a review"
  3. it "should let instructor/TAs review a previously saved review"
  4. it "should let instructor/TAs edit a previously saved review"
  5. it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

More testing:

  1. it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
  2. it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
  3. it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
  4. it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

References

Expertiza

Expertiza Github

Expertiza Documentation