Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-03T21:29:08Z

Jmmarsde:

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments was considered. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed using the same rubrics as the instructor.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in an assignment by checking "Calibration for training?" before assignment creation.

[[File:2021-11-03 011751.png]]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues of Previous work===
#The project assumes that the calibration starts at directory 0, which occasionally causes Expertiza to copy the wrong submission.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.

==Design==

==Implementation==

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-03T21:24:18Z

Jmmarsde: Grammar corrections

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments appeared to be a possible fix. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed using the same rubrics as the instructor.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in an assignment by checking "Calibration for training?" before assignment creation.

[[File:2021-11-03 011751.png]]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues of Previous work===
#The project assumes that the calibration starts at directory 0, which occasionally causes Expertiza to copy the wrong submission.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.

==Design==

==Implementation==

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-03T21:13:39Z

Jmmarsde: Clarify background and remove Expertiza introduction as it is implied that by being here they know what Expertiza is.

==Project Overview==
===Background===
To improve the experience of peer reviewing and to determine the competent reviewers amongst all the reviewers, the creation of a new form of review for assignments appeared to be a possible fix. As a result, so-called "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurs so that students would know if they reviewed using the same rubrics as the instructor.

To set up a calibration assignment that both the instructor and the students of the course can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course, in order to copy over the calibration assignments they have to repeat this process yet again.

===Objectives===
To fix the issue of needing to set up the calibration assignment repeatedly, the system should be able to make a copy of the previous calibration assignments with all attached reviews automatically.

===Previous Implementation===
In the previous implementation, the calibration review was designed as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor was able to enable the calibration review in an assignment by checking the box "Calibration for training?" prior to assignment creation.

[[File:2021-11-03 011751.png]]

[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that need to be addressed before merging into production.

===Issues of Previous work===
#The project assumes that the calibration starts at directory 0 which causes the wrong submission to be copied occasionally.
##Suggested Fix: set submitter_count to the largest directory number that was used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.

==Design==

==Implementation==

CSC/ECE 517 Fall 2021 - E2117. Refactor questionaires controller.rb

2021-10-27T04:10:51Z

Jmmarsde:

__TOC__

==Introduction==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using a [http://rubyonrails.org/ Ruby on Rails] framework. In Expertiza, an instructor can create, delete or edit new and existing assignments and also create topics for the students to sign up for or assign them to particular groups or individual students. A student can create teams to work on projects and assignments, and also peer review other's work. The website allows submission of various file type and also URL's.

===About questionnaire_controller.rb===
Questionnaire is the superclass for all kinds of [https://expertiza.csc.ncsu.edu/index.php/Questionnaires] and rubrics—rubrics for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. questionnaires_controller.rb is charged with creating, displaying, and managing Questionnaires. Since it is used so widely, malfunctions could cause bugs in many parts of the system; hence it is especially important that the code be clear.

==Issues to be addressed==
*Investigate the need and usage of the method create_questionnaire
*Refactor the create method into different methods with self-descriptive names for easier understanding
*The display_type attribute that was being set in the create method is never actually being used and is instead being overwritten by a post_initialization method on the types of objects being created.
*Investigate the usage of checks for whether a questionnaire is '''QuizQuestionnaire'''
*Replace hard-coded rubric criteria scoring
*Investigate usage of questionnaire_id parameter
*Bad if statements
*Refactor save_all_questions method - Cognitive Complexity and Assignment Branch Condition exceed allowed limit.
*Refactor copy method - Assignment Branch Condition is too high.

==Changes made==
*In none of the files was the create_questionaire method being called so it was deleted.
*Removed the display_type attribute and added a display_type method that pulls the correct display_type string from the subclass that is being utilized.
*Removed the Rubric class as it wasn't being used as far as I could tell. This will need to be verified by running a query on the production database.
*'''All the other issues couldn't be addressed due to the scope of the display_type attribute to method change suggested by the instructor and the conversion from using a type table to subclasses also suggested by the instructor ballooning the scope of the project to the point that the other changes went out of scope.'''

==Future Work==
*The Questionnaire table still has the display_type attribute and will need to be removed after an exploration of the data has been taken and verified that all display_types are represented by subclasses available.

==Team Members==
*Isha Gupta
*John Marsden
*Sai Harsha Nadendla

CSC/ECE 517 Fall 2021 - E2117. Refactor questionaires controller.rb

2021-10-22T00:20:48Z

Jmmarsde: Add Future Work section and address new changes that were made

__TOC__

==Introduction==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project developed using a [http://rubyonrails.org/ Ruby on Rails] framework. In Expertiza, an instructor can create, delete or edit new and existing assignments and also create topics for the students to sign up for or assign them to particular groups or individual students. A student can create teams to work on projects and assignments, and also peer review other's work. The website allows submission of various file type and also URL's.

===About questionnaire_controller.rb===
Questionnaire is the superclass for all kinds of [https://expertiza.csc.ncsu.edu/index.php/Questionnaires] and rubrics—rubrics for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. questionnaires_controller.rb is charged with creating, displaying, and managing Questionnaires. Since it is used so widely, malfunctions could cause bugs in many parts of the system; hence it is especially important that the code be clear.

==Issues to be addressed==
*Investigate the need and usage of the method create_questionnaire
*Refactor the create method into different methods with self-descriptive names for easier understanding
*The display_type attribute that was being set in the create method is never actually being used and is instead being overwritten by a post_initialization method on the types of objects being created.
*Investigate the usage of checks for whether a questionnaire is '''QuizQuestionnaire'''
*Replace hard-coded rubric criteria scoring
*Investigate usage of questionnaire_id parameter
*Bad if statements
*Refactor save_all_questions method - Cognitive Complexity and Assignment Branch Condition exceed allowed limit.
*Refactor copy method - Assignment Branch Condition is too high.

==Changes made==
*In none of the files was the create_questionaire method being called so it was deleted.
*Removed the display_type attribute and added a display_type method that pulls the correct display_type string from the subclass that is being utilized.
*Removed the Rubric class as it wasn't being used as far as I could tell. This will need to be verified by the running a query on the production database.

==Future Work==
*The Questionnaire table still has the display_type attribute and will need to be removed after an exploration of the data has been taken and verified that all display_types are represented by subclasses available.

==Team Members==
*Isha Gupta
*John Marsden
*Sai Harsha Nadendla