Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T04:55:59Z

Msaikia: /* Database Table Design */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Pattern ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we have iterated over the comments in each response(answers table) relating to a particular round to calculate the individual metrics. Also while calculating the aggregate metrics we have iterated through the review_metrics table to read the metric values for a particular user using all the responses for the particular response map corresponding to the submission of the review.

=== Database Table Design ===

[[File:Review_table.png]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is captured when a user submits a reviewer submits a review and passed on to the ReviewMetric model.This is used to link the metrics to a particular reviewer-response map.
*'''total_word_count:''' This attribute contains the total number of words for a particular review(response_id).
*'''diff_word_count:''' This attribute contains the total number of different words for a particular review(response_id).
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''complete_count:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Tasks Implemented ===

The project requires completion of the following tasks

# Create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted. [[File:Dbtable.png]]
# Create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calculate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calculate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence[[File:Model.png]]
# Create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages [[File:ViewCode1.png]] [[File:ViewCode2.png]] [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link [[File: InstTextMetric.png]]
# Make the code work for an assignment with and without the "vary rubric by rounds" feat
#* The ''calculate_metric'' code works for each review submission in a way where it uses the response_id of each review saved/submitted to find the review text saved in ''Answer'' table. The entire review text is then thoroughly checked to calculate the required metrics. Hence, any variation in the review rubrics does not affect this metric calculation.

=== Unit Tests ===
# Tested for a valid object, i.e. a valid ReviewMetric entry.
#Tested the ''ReviewMetric'' model so that it only calculates the metrics for a ReviewMetric entry with a valid response_id.
#Tested the ''ReviewMetric'' model so that it does not calculate the metrics for a ReviewMetric entry with an invalid response_id.
[[File: Testing1580.png]]

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

File:Review table.png

2015-12-05T04:55:27Z

Msaikia: review_metrics

review_metrics

File:Table.PNG

2015-12-05T04:54:57Z

Msaikia: uploaded a new version of "File:Table.PNG"

metrics_table

File:Table.PNG

2015-12-05T04:53:47Z

Msaikia: uploaded a new version of "File:Table.PNG"

metrics_table

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T04:49:06Z

Msaikia:

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Pattern ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we have iterated over the comments in each response(answers table) relating to a particular round to calculate the individual metrics. Also while calculating the aggregate metrics we have iterated through the review_metrics table to read the metric values for a particular user using all the responses for the particular response map corresponding to the submission of the review.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is captured when a user submits a reviewer submits a review and passed on to the ReviewMetric model.This is used to link the metrics to a particular reviewer-response map.
*'''total_word_count:''' This attribute contains the total number of words for a particular review(response_id).
*'''diff_word_count:''' This attribute contains the total number of different words for a particular review(response_id).
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''complete_count:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Tasks Implemented ===

The project requires completion of the following tasks

# Create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted. [[File:Dbtable.png]]
# Create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calculate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calculate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence[[File:Model.png]]
# Create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages [[File:ViewCode1.png]] [[File:ViewCode2.png]] [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link [[File: InstTextMetric.png]]
# Make the code work for an assignment with and without the "vary rubric by rounds" feat
#* The ''calculate_metric'' code works for each review submission in a way where it uses the response_id of each review saved/submitted to find the review text saved in ''Answer'' table. The entire review text is then thoroughly checked to calculate the required metrics. Hence, any variation in the review rubrics does not affect this metric calculation.

=== Unit Tests ===
# Tested for a valid object, i.e. a valid ReviewMetric entry.
#Tested the ''ReviewMetric'' model so that it only calculates the metrics for a ReviewMetric entry with a valid response_id.
#Tested the ''ReviewMetric'' model so that it does not calculate the metrics for a ReviewMetric entry with an invalid response_id.
[[File: Testing1580.png]]

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T04:48:04Z

Msaikia: /* Design Patterns */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Pattern ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we have iterated over the comments in each response(answers table) relating to a particular round to calculate the individual metrics. Also while calculating the aggregate metrics we have iterated through the review_metrics table to read the metric values for a particular user using all the responses for the particular response map corresponding to the submission of the review.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is captured when a user submits a reviewer submits a review and passed on to the ReviewMetric model.This is used to link the metrics to a particular reviewer-response map.
*'''total_word_count:''' This attribute contains the total number of words for a particular review(response_id).
*'''diff_word_count:''' This attribute contains the total number of different words for a particular review(response_id).
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''complete_count:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Tasks Implemented ===

The project requires completion of the following tasks

# Create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted. [[File:Dbtable.png]]
# Create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calculate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calculate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence[[File:Model.png]]
# Create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages [[File:ViewCode1.png]] [[File:ViewCode2.png]] [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link [[File: InstTextMetric.png]]
# Make the code work for an assignment with and without the "vary rubric by rounds" feat
#* The ''calculate_metric'' code works for each review submission in a way where it uses the response_id of each review saved/submitted to find the review text saved in ''Answer'' table. The entire review text is then thoroughly checked to calculate the required metrics. Hence, any variation in the review rubrics does not affect this metric calculation.

=== Unit Tests ===
# Tested for a valid object, i.e. a valid ReviewMetric entry.
#Tested the ''ReviewMetric'' model so that it only calculates the metrics for a ReviewMetric entry with a valid response_id.
#Tested the ''ReviewMetric'' model so that it does not calculate the metrics for a ReviewMetric entry with an invalid response_id.
[[File: Testing1580.png]]

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T04:47:42Z

Msaikia: /* Design Patterns */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we have iterated over the comments in each response(answers table) relating to a particular round to calculate the individual metrics. Also while calculating the aggregate metrics we have iterated through the review_metrics table to read the metric values for a particular user using all the responses for the particular response map corresponding to the submission of the review.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is captured when a user submits a reviewer submits a review and passed on to the ReviewMetric model.This is used to link the metrics to a particular reviewer-response map.
*'''total_word_count:''' This attribute contains the total number of words for a particular review(response_id).
*'''diff_word_count:''' This attribute contains the total number of different words for a particular review(response_id).
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''complete_count:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Tasks Implemented ===

The project requires completion of the following tasks

# Create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted. [[File:Dbtable.png]]
# Create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calculate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calculate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence[[File:Model.png]]
# Create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages [[File:ViewCode1.png]] [[File:ViewCode2.png]] [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link [[File: InstTextMetric.png]]
# Make the code work for an assignment with and without the "vary rubric by rounds" feat
#* The ''calculate_metric'' code works for each review submission in a way where it uses the response_id of each review saved/submitted to find the review text saved in ''Answer'' table. The entire review text is then thoroughly checked to calculate the required metrics. Hence, any variation in the review rubrics does not affect this metric calculation.

=== Unit Tests ===
# Tested for a valid object, i.e. a valid ReviewMetric entry.
#Tested the ''ReviewMetric'' model so that it only calculates the metrics for a ReviewMetric entry with a valid response_id.
#Tested the ''ReviewMetric'' model so that it does not calculate the metrics for a ReviewMetric entry with an invalid response_id.
[[File: Testing1580.png]]

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T04:43:05Z

Msaikia: /* Test Plan */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is captured when a user submits a reviewer submits a review and passed on to the ReviewMetric model.This is used to link the metrics to a particular reviewer-response map.
*'''total_word_count:''' This attribute contains the total number of words for a particular review(response_id).
*'''diff_word_count:''' This attribute contains the total number of different words for a particular review(response_id).
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''complete_count:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Tasks Implemented ===

The project requires completion of the following tasks

# Create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted. [[File:Dbtable.png]]
# Create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calculate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calculate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence[[File:Model.png]]
# Create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages [[File:ViewCode1.png]] [[File:ViewCode2.png]] [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link [[File: InstTextMetric.png]]
# Make the code work for an assignment with and without the "vary rubric by rounds" feat
#* The ''calculate_metric'' code works for each review submission in a way where it uses the response_id of each review saved/submitted to find the review text saved in ''Answer'' table. The entire review text is then thoroughly checked to calculate the required metrics. Hence, any variation in the review rubrics does not affect this metric calculation.

=== Unit Tests ===
# Tested for a valid object, i.e. a valid ReviewMetric entry.
#Tested the ''ReviewMetric'' model so that it only calculates the metrics for a ReviewMetric entry with a valid response_id.
#Tested the ''ReviewMetric'' model so that it does not calculate the metrics for a ReviewMetric entry with an invalid response_id.
[[File: Testing1580.png]]

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T04:42:52Z

Msaikia: /* Test Plan */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is captured when a user submits a reviewer submits a review and passed on to the ReviewMetric model.This is used to link the metrics to a particular reviewer-response map.
*'''total_word_count:''' This attribute contains the total number of words for a particular review(response_id).
*'''diff_word_count:''' This attribute contains the total number of different words for a particular review(response_id).
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''complete_count:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Tasks Implemented ===

The project requires completion of the following tasks

# Create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted. [[File:Dbtable.png]]
# Create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calculate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calculate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence[[File:Model.png]]
# Create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages [[File:ViewCode1.png]] [[File:ViewCode2.png]] [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link [[File: InstTextMetric.png]]
# Make the code work for an assignment with and without the "vary rubric by rounds" feat
#* The ''calculate_metric'' code works for each review submission in a way where it uses the response_id of each review saved/submitted to find the review text saved in ''Answer'' table. The entire review text is then thoroughly checked to calculate the required metrics. Hence, any variation in the review rubrics does not affect this metric calculation.

=== Unit Tests ===
# Tested for a valid object, i.e. a valid ReviewMetric entry.
#Tested the ''ReviewMetric'' model so that it only calculates the metrics for a ReviewMetric entry with a valid response_id.
#Tested the ''ReviewMetric'' model so that it does not calculate the metrics for a ReviewMetric entry with an invalid response_id.
[[File: Testing1580.png]]

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T04:42:07Z

Msaikia: /* Database Table Design */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is captured when a user submits a reviewer submits a review and passed on to the ReviewMetric model.This is used to link the metrics to a particular reviewer-response map.
*'''total_word_count:''' This attribute contains the total number of words for a particular review(response_id).
*'''diff_word_count:''' This attribute contains the total number of different words for a particular review(response_id).
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''complete_count:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Tasks Implemented ===

The project requires completion of the following tasks

# Create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted. [[File:Dbtable.png]]
# Create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calculate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calculate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence[[File:Model.png]]
# Create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages [[File:ViewCode1.png]] [[File:ViewCode2.png]] [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link [[File: InstTextMetric.png]]
# Make the code work for an assignment with and without the "vary rubric by rounds" feat
#* The ''calculate_metric'' code works for each review submission in a way where it uses the response_id of each review saved/submitted to find the review text saved in ''Answer'' table. The entire review text is then thoroughly checked to calculate the required metrics. Hence, any variation in the review rubrics does not affect this metric calculation.

=== Unit Tests ===
# Tested for a valid object, i.e. a valid ReviewMetric entry.
#Tested the ''ReviewMetric'' model so that it only calculates the metrics for a ReviewMetric entry with a valid response_id.
#Tested the ''ReviewMetric'' model so that it does not calculate the metrics for a ReviewMetric entry with an invalid response_id.
[[File: Testing1580.png]]

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T03:04:46Z

Msaikia: /* UML Diagram */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
===UML Diagram===
[[File:UML_Review_Metrics.png]]

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted.
#* [[File:Dbtable.png]]
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calulate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calulate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence
#* [[File:Model.png]]
# create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages
#* [[File:ViewCode1.png]]
#* [[File:ViewCode2.png]]
#* [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review
#* [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link
#* [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment
#* [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link
#* [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link
#* [[File: InstTextMetric.png]]
# make the code work for an assignment with and without the "vary rubric by rounds" feat
# create tests to make sure the test coverage increases

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

File:UML Review Metrics.png

2015-12-05T03:04:05Z

Msaikia:

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T03:03:23Z

Msaikia: /* Implementation */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
===UML Diagram===
=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted.
#* [[File:Dbtable.png]]
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calulate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calulate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence
#* [[File:Model.png]]
# create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages
#* [[File:ViewCode1.png]]
#* [[File:ViewCode2.png]]
#* [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review
#* [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link
#* [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment
#* [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link
#* [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link
#* [[File: InstTextMetric.png]]
# make the code work for an assignment with and without the "vary rubric by rounds" feat
# create tests to make sure the test coverage increases

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T03:01:48Z

Msaikia: /* Use Cases */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted.
#* [[File:Dbtable.png]]
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calulate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calulate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence
#* [[File:Model.png]]
# create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages
#* [[File:ViewCode1.png]]
#* [[File:ViewCode2.png]]
#* [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review
#* [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link
#* [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment
#* [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link
#* [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link
#* [[File: InstTextMetric.png]]
# make the code work for an assignment with and without the "vary rubric by rounds" feat
# create tests to make sure the test coverage increases

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T03:01:35Z

Msaikia: /* Use Cases */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.

# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted.
#* [[File:Dbtable.png]]
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calulate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calulate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence
#* [[File:Model.png]]
# create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages
#* [[File:ViewCode1.png]]
#* [[File:ViewCode2.png]]
#* [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review
#* [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link
#* [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment
#* [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link
#* [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link
#* [[File: InstTextMetric.png]]
# make the code work for an assignment with and without the "vary rubric by rounds" feat
# create tests to make sure the test coverage increases

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T02:59:25Z

Msaikia: /* Mockups */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted.
#* [[File:Dbtable.png]]
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calulate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calulate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence
#* [[File:Model.png]]
# create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment. These views are accessible through links in the student report page and instructor ''_review_report.html.erb'' page
#* The following are screenshots where the links are included in the above mentioned pages
#* [[File:ViewCode1.png]]
#* [[File:ViewCode2.png]]
#* [[File:ViewCode3.png]]
#* The following is a screenshot when a student saves or submits a review
#* [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link
#* [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment
#* [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link
#* [[File: InstAggMetric.png]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link
#* [[File: InstTextMetric.png]]
# make the code work for an assignment with and without the "vary rubric by rounds" feat
# create tests to make sure the test coverage increases

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-12-05T01:31:20Z

Msaikia: /* Task Description */

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source [https://en.wikipedia.org/wiki/Peer_review peer-review] based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the [https://en.wikipedia.org/wiki/Ruby_on_Rails Ruby on Rails] framework and is supported by the [http://www.nsf.gov National Science Foundation]

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual [https://en.wikipedia.org/wiki/Peer_review peer-review] mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create views for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern<ref>https://en.wikipedia.org/wiki/Iterator_pattern</ref>:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern<ref>https://en.wikipedia.org/wiki/Flyweight_pattern</ref>:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: [https://en.wikipedia.org/wiki/Git_(software) Git], Interactive Ruby
== Implementation ==
=== Task Description ===

The project requires completion of the following tasks

# create database table to record all the metrics
#* A new MVC by the name ''ReviewMetric'' has been added to the project.
#* A table ''review_metrics'' is used for the same. It has the following columns to record data with respect to each response, i.e. review submitted.
#* A new row is updated in the table when a new review is saved or submitted and the respective row gets updated when an existing review is re-edited or submitted.
#* [[File:Dbtable.png]]
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
#* The code for evaluating the metrics value as per each review is saved in the function ''calulate_metric'' at the model ''review_metric.rb''
#* This code is called from the function ''saving'' residing at ''response_controller.rb''. The ''saving'' function gets called post necessary processing when a review is saved or submitted. The ''calulate_metric'' method is called at the end of the ''saving'' method to analyse the review and save respective information according to the requirement.
#* The calculation code uses the ''Answer'' table to pull out the saved review content using the ''response_id'' of the review. It incorporates a set each for offensive words list, suggestive words list, and a list of problem pointing words. The function then calculates the following:
#** Total number of words in the review
#** Different number of words in the review
#** Number of offensive words in the review - the method uses a set of offensive words as a dictionary and compares this with each word in the review
#** Number of words which signals a suggestion in the review - the method uses a set of suggestive words as a dictionary and compares this with each word in the review
#** Number of words which signal a problem being pointed out in the review - the method uses a set of problem pointing words as a dictionary and compares this with each word in the review
#** Number of questions responded to with complete sentences - each sentence which has more than seven words qualify for a complete sentence
#* [[File:Model.png]]
# create partials for both students and instructors:
#* Views are created for both students and instructors to display the ''text metrics'' calculated for each review and assignment
#* The following is a screenshot when a student saves or submits a review
#* [[File:StuReviewHome.png]]
#* The following is a screenshot when the student clicks the ''View Text Metrics'' link
#* [[File: StuReviewDetail.png]]
#* The following is a screenshot when an instructor uses the ''View Review Report'' link at the assignments page for a given assignment
#* [[File: InstReviewReport.png]]
#* The following is a screenshot when the instructor clicks the ''text metrics summary'' link
#* [[File: ]]
#* The following is a screenshot when the instructor clicks the individual ''text metrics'' link
#* [[File: InstTextMetric.png]]
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

== Reference ==
<references/>

== External links ==
*[https://github.com/moharnab123saikia/expertiza/ Expertiza Github Repository]

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T02:22:33Z

Msaikia: /* Database Table Design */

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:''' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T02:22:17Z

Msaikia: /* Database Table Design */

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

The image shows the schema for the new table which will be created to store the calculated values of the metrics. Its attributes are explained below:

*'''response_id:''' This attribute is automatically generated when a user submits a reviewer submits a review.This can be used to link the metrics to a particular reviewer-response map.
*'''word_count:'' This attribute contains the total number of different words for a particular review.
*'''suggestions_count:''' This column holds the number of suggestions given per review
*'''error_count:''' Field containing the number of comments which point to errors in the code.
*'''offensive_count:''' This attribute contains the number of comments containing offensive words.
*'''comp_reviews:''' This contains the number of comments which have complete sentences in them.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T02:10:27Z

Msaikia: /* Design */

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

=== Database Table Design ===

[[File:Table.PNG]]

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

File:Table.PNG

2015-11-14T02:09:54Z

Msaikia: metrics_table

metrics_table

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T01:50:22Z

Msaikia: /* Design */

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

=== Design Patterns ===

'''Iterator Pattern:'''The iterator design pattern uses an iterator to traverse a container and access its elements.In our implementation, we would require showing the review metrics for each response.So, we can use the iterator design pattern to iterate over the calculated metrics values.

'''FlyWeight Pattern:''' The flyweight design pattern tries to reduce memory footprint by reusing already existing similar objects by storing them and only creates new object when there is no match. In our case, we can use the same partials of the metrics pages for both the students and instructors.

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T01:34:33Z

Msaikia: /* Mockups */

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

====Instructor Panel====

The image represents instructors view of the Review report after our modifications.The instructor can click '''Show aggregate metrics''' link to view the aggregate metrics for each team for a given assignment.

[[File:Inst_aggregate_metrics.png]]

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

File:Inst aggregate metrics.png

2015-11-14T01:30:57Z

Msaikia:

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T01:05:18Z

Msaikia: /* Reviewer Panel */

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.

[[File:User_metrics.PNG]]

The reviewer can also click the '''Show metrics''' link for each individual review to view the specific metrics for that review.

[[File:Review_metrics.PNG]]

== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T00:58:52Z

Msaikia:

== Introduction ==
Expertiza is an open-source peer-review based web application which allows for incremental learning. Students can submit learning objects such as articles, wiki pages, repository links and with the help of peer reviews, improve them. The project has been developed using the Ruby on Rails framework and is supported by the National Science Foundation

== Project ==

=== Purpose ===
The current version of The Expertiza Project has an automated meta-review system wherein the reviewer gets an e-mail containing various metrics of his review like relevance, plagiarism, number of words etc. , whenever a review is submitted. The purpose of this project is to give students some metrics on the content of the review when the automated meta reviews are disabled. This also includes the addition of new relevant metrics which can help the reviewers and instructors to gain insight into the reviews.

=== Scope ===
The scope of the project is limited creating a system where the reviewer and the instructors can view metrics for the submitted reviews.The user or the instructor need to manually visit the link to view the metrics.The instructor can view the metrics for every assignment available whereas the user can view only the metrics of the assignments relating to himself.The scope doesn't include any automated viewing of reports for the metrics.Since the project is mainly related to giving reports about the existing data, we will not be modifying the results saved by the actual peer-review mechanism.The scope also excludes any change of the actual peer review process i.e. submitting a review of an assignment or adding an assignment to a user profile.

=== Task Description ===

The project requires completion of the following tasks

# create database table to the metrics
# create code to calculate the values of the metrics and also ensure that the code runs fast enough (can give results within 5 seconds) as the current auto text metrics functionality is very slow and diminishes user experience.
# create partials for both students and instructors that show for each assignment:
#* Total no.of words
#* average no. of words for all the reviews for the particular assignment in a particular round
#* if there are suggestions in each reviewer's review
#* the percentage of peer reviews that offer any suggestions
#* if problems or errors are pointed out in the reviews
#* the percentage of the peer-reviews which point out problems in this assignment in this round
#* if any offensive language is used
#* the percentage of peer-reviews containing offensive language
#* No.of different words in a particular reviewer’s review
#* No. of questions responded to with complete sentences
# make the code work for an assignment with and without the "vary rubric by rounds" feature
# create tests to make sure the test coverage increases

=== Workflow ===
[[File:e1580flow.JPG]]

== Design ==
=== Mockups ===
====Reviewer Panel====
The diagrams below show the proposed changes through the perspective of a reviewer.The reviewer can click the '''Show aggregate metrics''' link to view the aggregate metrics.
[[File:User_metrics.PNG]]

[[File:Review_metrics.PNG]]
== Use Cases ==

# '''View Reviews Text Metrics as Reviewer:''' As a reviewer, he/she can see the text metrics of individual reviews as well as aggregate metrics for all the reviews done for an assignment/project.
# '''View Reviews Text Metrics as Reviewee:''' As a reviewee, he/she can see the text metrics of individual reviews received from reviewers as well as aggregate metrics for all the reviews received for an assignment/project.
# '''View Reviews Text Metrics as Instructor:''' As an instructor, he/she can see the text metrics of reviews received by any team for a particular project/assignment. The instructor can also see the text metrics of the reviews done by any reviewer.

== Test Plan ==

#For '''use case 1''', test whether the text metrics Db has entries populated for each type of metrics (no. of words, no. of offensive words, etc), once the reviewer submits any reviews.
#For '''use case 2''', test if the reviewer can see the text metrics of individual reviews received from all reviewers.
#For '''use case 3''', test if the instructor can see the text metrics of reviews received by each team for a project/assignment. Also, test if the instructor can see the text metrics done by any reviewer.

==Details of Requirements==
===Hardware requirements===
* Computing Power: Same as the current Expertiza system.

* Memory: Same as the current Expertiza system.

* Disk Storage: Same as the current Expertiza system.

* Peripherals: Same as the current Expertiza system.

* Network: Same as the current Expertiza system.

===Software requirements===
* Operating system environment : Windows/UNIX/OS X based OS

* Networking environment: Same as it is used in the current Expertiza system

* Tools: Git, Interactive Ruby

File:Review metrics.PNG

2015-11-14T00:55:57Z

Msaikia: uploaded a new version of "File:Review metrics.PNG"

aggregate metrics for reviewer in expertiza

File:User metrics.PNG

2015-11-14T00:54:21Z

Msaikia: uploaded a new version of "File:User metrics.PNG"

metrics in reviewer page for particular review

File:User metrics.PNG

2015-11-14T00:53:31Z

Msaikia: uploaded a new version of "File:User metrics.PNG"

metrics in reviewer page for particular review

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T00:50:33Z

Msaikia: /*design*/

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T00:49:05Z

Msaikia: added mockup images

File:User metrics.PNG

2015-11-14T00:47:05Z

Msaikia: metrics in reviewer page for particular review

metrics in reviewer page for particular review

File:Review metrics.PNG

2015-11-14T00:45:13Z

Msaikia: aggregate metrics for reviewer in expertiza

aggregate metrics for reviewer in expertiza

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T00:43:12Z

Msaikia: added test plan

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T00:41:14Z

Msaikia: added use cases

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-14T00:35:44Z

Msaikia: /* Task Description */

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-13T23:07:28Z

Msaikia: /* Task Description */

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-10T23:21:28Z

Msaikia: task desc

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-10T22:01:19Z

Msaikia: /* Scope */

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-10T21:54:03Z

Msaikia: /* Scope */

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-10T21:49:09Z

Msaikia: /* Scope */

CSC/ECE 517 Fall 2015 E1580 Text metrics

2015-11-10T20:31:40Z

Msaikia: Introduction to Expertiza

CSC/ECE 517 Fall 2015

2015-11-10T20:08:52Z

Msaikia: /* Final Project Design Document */

==Writing Assignment 2==
*[[CSC/ECE_517_Fall_2015/sample_page]]
*[[CSC/ECE_517_Fall_2015/ossE1558BGJ]]
*[[CSC/ECE 517 Fall 2015/oss/M1502/AAAASS]]
*[[CSC/ECE 517 Fall 2015/oss/M1503/IntegrateXMLParser]]
*[[CSC/ECE_517_Fall_2015/ossE1568BZHXJS]]
*[[CSC/ECE_517_Fall_2015/ossE1572VGA]]
*[[CSC/ECE_517_Fall_2015/oss_E1573_sap]]
*[[CSC/ECE 517 Fall 2015/oss E1559 rrz]]
*[[CSC/ECE 517 Fall 2015/oss E1570 avr]]
*[[CSC/ECE 517 Fall 2015/oss E1556 CHM]]
*[[CSC/ECE 517 Fall 2015/oss M1504 JJD]]
*[[CSC/ECE 517 Fall 2015/oss E1562 APS]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss E1550 KMM]]
*[[CSC/ECE 517 Fall 2015/oss E1551 RGS]]
*[[CSC/ECE 517 Fall 2015/oss E1555 GMR]]
*[[CSC/ECE 517 Fall 2015/oss E1552 NFR]]
*[[CSC/ECE 517 Fall 2015/oss E1565 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1561 WZL]]
*[[CSC/ECE 517 Fall 2015/oss E1553 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1554 AAR]]
*[[CSC/ECE 517 Fall 2015/oss E1569 JNR]]
*[[CSC/ECE 517 Fall 2015/oss E1560 PSV]]
*[[CSC/ECE 517 Fall 2015/oss M1505 MSV]]
*[[CSC/ECE 517 Fall 2015/oss E1557 GXM]]
*[[CSC/ECE 517 Fall 2015/oss E1566 ARB]]
*[[CSC/ECE 517 Fall 2015/oss E1567 APT]]
*[[CSC/ECE 517 Fall 2015/oss E1574 BKS]]
*[[CSC/ECE 517 Fall 2015/ossA1550RAN]]
*[[CSC/ECE 517 Fall 2015/oss E1571]]

==Final Project Design Document==
*[[CSC/ECE 517 Fall 2015 E1577 MayYellowRoverJump]]
*[[CSC/ECE 517 Fall 2015 E1586 AnonymousChatBetweenAuthorAndReviewer]]
*[[CSC/ECE 517 Fall 2015 E1580 Text metrics]]
*[[CSC/ECE 517 Fall 2015 E1582 Create integration tests for the instructor interface using capybara and rspec]]
*[[CSC/ECE 517 Fall 2015 E1576 Refactoring submitted content (hyperlinks and files)]]
*[[CSC/ECE 517 Fall 2015 E1590 Integration testing for Team creation]]
*[[CSC/ECE 517 Fall 2015 E1585 Use Ajax for Add Participants, Add TA ,Edit Questionnaires Screens]]
*[[CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface]]
*[[CSC/ECE 517 Fall 2015 E1583 Fix the CSS used for Menu Item]]
*[[CSC/ECE 517 Fall 2015 E1591 Integration testing for peer review]]
*[[CSC/ECE 517 Fall 2015 E1589 Automating production setup and deployment]]
*[[CSC/ECE 517 Fall 2015 M1502 Improve HTTP monitoring devtool support]]
*[[CSC/ECE 517 Fall 2015 M1503 Integrate xml5ever XML parser]]
*[[CSC/ECE 517 Fall 2015 M1504 Implement support for missing XMLHttpRequest APIs]]
*[[CSC/ECE 517 Fall 2015 M1505 Add conformance tests to unicode-bidi and fix conformance bugs]]
*[[CSC/ECE 517 Fall 2015 M1501 Report CSS errors to the devtools, both stored and live]]
*[[CSC/ECE 517 Fall 2015 E1579 Instructor account creation over the web]]
*[[CSC/ECE 517 Fall 2015 A1550 Web Socket Implementation in Apache Ambari]]
*[[CSC/ECE 517 Fall 2015 E1584 Send Feedback to Support]]

CSC/ECE 517 Fall 2015/oss M1505 MSV

2015-10-31T23:26:10Z

Msaikia: /* Testing in Rust */

=='''M1505: Add conformance tests to unicode-bidi and fix conformance bugs'''==
This project involved adding conformance tests to the Servo implementation of the Unicode Bidirectional algorithm (unicode-bidi).

=='''Problem Statement'''==

Web browsers are expected to support international text, and Servo is no exception. The unicode-bidi library built into servo implements the [[Unicode Bidirectional Algorithm]] for display of mixed right-to-left and left-to-right text. This library's conformance with the Unicode Bidirectional Algorithm specification has yet to be comprehensively tested.

The primary objectives of this project involved:

* Adding code to tools/generate.py to download the two specification files listed below, that make up the conformance testsuite:http://www.unicode.org/Public/UNIDATA/BidiTest.txt and http://www.unicode.org/Public/UNIDATA/BidiCharacterTest.txt

* Conversion and extension of one or more test cases from the specification files into Rust test cases that can be run automatically.

=='''Changes and Implementation'''==

===Initial Steps===

The following steps were performed in more or less serial order:

* The current directory being pointed to by the running Python instance was modified. Since this instance points by default to the directory where the source file exists, it was pointing to the /tools/ directory. Instead it was made to point to the /src/ directory, where it could modify / check existence of existing files and download new files.

* After changing the current directory, the predefined fetch() function was used to download and save the two files that make up the conformance test suite.

* Once the files were fetched several test cases were inserted to test the conformance of the unicode-bidi implementation. The test cases that were added included:
** Several cases of line reordering
** Several cases where the RTL recognition was checked
** Several cases where the LTR recognition was checked
** All cases where the removal of characters as per the step X9 were tested
** All cases where the characters that weren't supposed to be removed as per the step X9 were tested

===Forked Branch===

The forked branch for our project can be found [https://github.com/moharnab123saikia/unicode-bidi here].

===Pull Request===

The pull request can be found [https://github.com/servo/unicode-bidi/pull/19 here].

===Project Walk-through Video===

The demonstration video of our project can be found [https://www.youtube.com/watch?v=f_Gw-usX0z0 here].

=='''Mozilla Servo'''==

Servo<ref>https://github.com/servo/servo</ref> is a Web Browser engine written using the Rust<ref>https://www.rust-lang.org/</ref> programming platform. Servo is an experimental project build that is optimized for new generations of hardware, particularly mobile devices, devices with multi-core processors and those with high-performance GPUs. It's core design principles are focused on optimizing power efficiency along with maximizing parallelism.<ref>https://en.wikipedia.org/wiki/Servo_(layout_engine)</ref>

=='''Rust'''==
Rust is a multi-paradigm, compiled programming language developed by Mozilla Research. The syntax of Rust is similar to C and C++.
Rust has a self hosting compiler, rustc. <ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>

New projects can be created in Rust using [https://doc.rust-lang.org/book/hello-cargo.html Cargo]. Cargo is the package manager for Rust. It also builds the rust code and manages its dependencies.<ref>http://siciarz.net/24-days-rust-cargo-and-cratesio/</ref>

A new Rust project can be created using the command:

$ cargo new project_name

===Testing in Rust===

Cargo will automatically generate a simple test when you make a new project. This new test function can be found in src/lib.rs. #[test] attribute indicates that a given function is a test function.<ref>https://doc.rust-lang.org/book/testing.html</ref>

The standard format for test functions is:
<pre>
<nowiki>#[test]</nowiki> 

fn test_method() { 
  
 }
</pre>
The tests can be run using the following command:

$ cargo test

=='''Unicode Bidirectional Algorithm'''==
The Unicode Standard prescribes a memory representation order of text for browsers known as logical order.But the order they display text is different and is called the visual order.

When text is displayed horizontally, most scripts display the characters from left to right.However in case of languages like Arabic, Hebrew etc. the ordering is from right to left.Also, they have digits that are displayed from left to right.So, the text is bidirectional in nature.In addition, these languages may also have embedded in them, letters from scripts that are displayed from left to right.

To remove any ambiguities that may arise the Unicode Bidirectional Algorithm provides a set of rules which are used by a web-browser to produce the correct order at the time of display.

=='''External Links'''==
[https://github.com/servo/servo/wiki/Design Servo Design]

=='''References'''==
<references/>

CSC/ECE 517 Fall 2015/oss M1505 MSV

2015-10-31T23:19:44Z

Msaikia: /* Unicode Bidirectional Algorithm */

=='''M1505: Add conformance tests to unicode-bidi and fix conformance bugs'''==
This project involved adding conformance tests to the Servo implementation of the Unicode Bidirectional algorithm (unicode-bidi).

=='''Problem Statement'''==

Web browsers are expected to support international text, and Servo is no exception. The unicode-bidi library built into servo implements the [[Unicode Bidirectional Algorithm]] for display of mixed right-to-left and left-to-right text. This library's conformance with the Unicode Bidirectional Algorithm specification has yet to be comprehensively tested.

The primary objectives of this project involved:

* Adding code to tools/generate.py to download the two specification files listed below, that make up the conformance testsuite:http://www.unicode.org/Public/UNIDATA/BidiTest.txt and http://www.unicode.org/Public/UNIDATA/BidiCharacterTest.txt

* Conversion and extension of one or more test cases from the specification files into Rust test cases that can be run automatically.

=='''Changes and Implementation'''==

===Initial Steps===

The following steps were performed in more or less serial order:

* The current directory being pointed to by the running Python instance was modified. Since this instance points by default to the directory where the source file exists, it was pointing to the /tools/ directory. Instead it was made to point to the /src/ directory, where it could modify / check existence of existing files and download new files.

* After changing the current directory, the predefined fetch() function was used to download and save the two files that make up the conformance test suite.

* Once the files were fetched several test cases were inserted to test the conformance of the unicode-bidi implementation. The test cases that were added included:
** Several cases of line reordering
** Several cases where the RTL recognition was checked
** Several cases where the LTR recognition was checked
** All cases where the removal of characters as per the step X9 were tested
** All cases where the characters that weren't supposed to be removed as per the step X9 were tested

===Forked Branch===

The forked branch for our project can be found [https://github.com/moharnab123saikia/unicode-bidi here].

===Pull Request===

The pull request can be found [https://github.com/servo/unicode-bidi/pull/19 here].

===Project Walk-through Video===

The demonstration video of our project can be found [https://www.youtube.com/watch?v=f_Gw-usX0z0 here].

=='''Mozilla Servo'''==

Servo<ref>https://github.com/servo/servo</ref> is a Web Browser engine written using the Rust<ref>https://www.rust-lang.org/</ref> programming platform. Servo is an experimental project build that is optimized for new generations of hardware, particularly mobile devices, devices with multi-core processors and those with high-performance GPUs. It's core design principles are focused on optimizing power efficiency along with maximizing parallelism.<ref>https://en.wikipedia.org/wiki/Servo_(layout_engine)</ref>

=='''Rust'''==
Rust is a multi-paradigm, compiled programming language developed by Mozilla Research. The syntax of Rust is similar to C and C++.
Rust has a self hosting compiler, rustc. <ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>

New projects can be created in Rust using [https://doc.rust-lang.org/book/hello-cargo.html Cargo]. Cargo is the package manager for Rust. It also builds the rust code and manages its dependencies.<ref>http://siciarz.net/24-days-rust-cargo-and-cratesio/</ref>

A new Rust project can be created using the command:

$ cargo new project_name

===Testing in Rust===

Cargo will automatically generate a simple test when you make a new project. This new test function can be found in src/lib.rs. #[test] attribute indicates that a given function is a test function.<ref>https://doc.rust-lang.org/book/testing.html</ref>

The standard format for test functions is:

<nowiki>#[test]</nowiki> 

fn test_method() { 
  
 }

The tests can be run using the following command:

$ cargo test

=='''Unicode Bidirectional Algorithm'''==
The Unicode Standard prescribes a memory representation order of text for browsers known as logical order.But the order they display text is different and is called the visual order.

When text is displayed horizontally, most scripts display the characters from left to right.However in case of languages like Arabic, Hebrew etc. the ordering is from right to left.Also, they have digits that are displayed from left to right.So, the text is bidirectional in nature.In addition, these languages may also have embedded in them, letters from scripts that are displayed from left to right.

To remove any ambiguities that may arise the Unicode Bidirectional Algorithm provides a set of rules which are used by a web-browser to produce the correct order at the time of display.

=='''External Links'''==
[https://github.com/servo/servo/wiki/Design Servo Design]

=='''References'''==
<references/>

CSC/ECE 517 Fall 2015/oss M1505 MSV

2015-10-31T23:19:24Z

Msaikia:

=='''M1505: Add conformance tests to unicode-bidi and fix conformance bugs'''==
This project involved adding conformance tests to the Servo implementation of the Unicode Bidirectional algorithm (unicode-bidi).

=='''Problem Statement'''==

Web browsers are expected to support international text, and Servo is no exception. The unicode-bidi library built into servo implements the [[Unicode Bidirectional Algorithm]] for display of mixed right-to-left and left-to-right text. This library's conformance with the Unicode Bidirectional Algorithm specification has yet to be comprehensively tested.

The primary objectives of this project involved:

* Adding code to tools/generate.py to download the two specification files listed below, that make up the conformance testsuite:http://www.unicode.org/Public/UNIDATA/BidiTest.txt and http://www.unicode.org/Public/UNIDATA/BidiCharacterTest.txt

* Conversion and extension of one or more test cases from the specification files into Rust test cases that can be run automatically.

=='''Changes and Implementation'''==

===Initial Steps===

The following steps were performed in more or less serial order:

* The current directory being pointed to by the running Python instance was modified. Since this instance points by default to the directory where the source file exists, it was pointing to the /tools/ directory. Instead it was made to point to the /src/ directory, where it could modify / check existence of existing files and download new files.

* After changing the current directory, the predefined fetch() function was used to download and save the two files that make up the conformance test suite.

* Once the files were fetched several test cases were inserted to test the conformance of the unicode-bidi implementation. The test cases that were added included:
** Several cases of line reordering
** Several cases where the RTL recognition was checked
** Several cases where the LTR recognition was checked
** All cases where the removal of characters as per the step X9 were tested
** All cases where the characters that weren't supposed to be removed as per the step X9 were tested

===Forked Branch===

The forked branch for our project can be found [https://github.com/moharnab123saikia/unicode-bidi here].

===Pull Request===

The pull request can be found [https://github.com/servo/unicode-bidi/pull/19 here].

===Project Walk-through Video===

The demonstration video of our project can be found [https://www.youtube.com/watch?v=f_Gw-usX0z0 here].

=='''Mozilla Servo'''==

Servo<ref>https://github.com/servo/servo</ref> is a Web Browser engine written using the Rust<ref>https://www.rust-lang.org/</ref> programming platform. Servo is an experimental project build that is optimized for new generations of hardware, particularly mobile devices, devices with multi-core processors and those with high-performance GPUs. It's core design principles are focused on optimizing power efficiency along with maximizing parallelism.<ref>https://en.wikipedia.org/wiki/Servo_(layout_engine)</ref>

=='''Rust'''==
Rust is a multi-paradigm, compiled programming language developed by Mozilla Research. The syntax of Rust is similar to C and C++.
Rust has a self hosting compiler, rustc. <ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>

New projects can be created in Rust using [https://doc.rust-lang.org/book/hello-cargo.html Cargo]. Cargo is the package manager for Rust. It also builds the rust code and manages its dependencies.<ref>http://siciarz.net/24-days-rust-cargo-and-cratesio/</ref>

A new Rust project can be created using the command:

''$ cargo new project_name''

===Testing in Rust===

Cargo will automatically generate a simple test when you make a new project. This new test function can be found in src/lib.rs. #[test] attribute indicates that a given function is a test function.<ref>https://doc.rust-lang.org/book/testing.html</ref>

The standard format for test functions is:

<nowiki>#[test]</nowiki> 

fn test_method() { 
  
 }

The tests can be run using the following command:

''$ cargo test''

=='''Unicode Bidirectional Algorithm'''==
The Unicode Standard prescribes a memory representation order of text for browsers known as logical order.But the order they display text is different and is called the visual order.

When text is displayed horizontally, most scripts display the characters from left to right.However in case of languages like Arabic, Hebrew etc. the ordering is from right to left.Also, they have digits that are displayed from left to right.So, the text is bidirectional in nature.In addition, these languages may also have embedded in them, letters from scripts that are displayed from left to right.

To remove any ambiguities that may arise the Unicode Bidirectional Algorithm provides a set of rules which are used by a web-browser to produce the correct order at the time of display.

=='''External Links'''==
[https://github.com/servo/servo/wiki/Design Servo Design]

=='''References'''==
<references/>

CSC/ECE 517 Fall 2015/oss M1505 MSV

2015-10-31T23:18:10Z

Msaikia: Added content for "BIDI algo"

=='''M1505: Add conformance tests to unicode-bidi and fix conformance bugs'''==
This project involved adding conformance tests to the Servo implementation of the Unicode Bidirectional algorithm (unicode-bidi).

=='''Problem Statement'''==

Web browsers are expected to support international text, and Servo is no exception. The unicode-bidi library built into servo implements the [[Unicode Bidirectional Algorithm]] for display of mixed right-to-left and left-to-right text. This library's conformance with the Unicode Bidirectional Algorithm specification has yet to be comprehensively tested.

The primary objectives of this project involved:

* Adding code to tools/generate.py to download the two specification files listed below, that make up the conformance testsuite:http://www.unicode.org/Public/UNIDATA/BidiTest.txt and http://www.unicode.org/Public/UNIDATA/BidiCharacterTest.txt

* Conversion and extension of one or more test cases from the specification files into Rust test cases that can be run automatically.

=='''Changes and Implementation'''==

===Initial Steps===

The following steps were performed in more or less serial order:

* The current directory being pointed to by the running Python instance was modified. Since this instance points by default to the directory where the source file exists, it was pointing to the /tools/ directory. Instead it was made to point to the /src/ directory, where it could modify / check existence of existing files and download new files.

* After changing the current directory, the predefined fetch() function was used to download and save the two files that make up the conformance test suite.

* Once the files were fetched several test cases were inserted to test the conformance of the unicode-bidi implementation. The test cases that were added included:
** Several cases of line reordering
** Several cases where the RTL recognition was checked
** Several cases where the LTR recognition was checked
** All cases where the removal of characters as per the step X9 were tested
** All cases where the characters that weren't supposed to be removed as per the step X9 were tested

===Forked Branch===

The forked branch for our project can be found [https://github.com/moharnab123saikia/unicode-bidi here].

===Pull Request===

The pull request can be found [https://github.com/servo/unicode-bidi/pull/19 here].

===Project Walk-through Video===

The demonstration video of our project can be found [https://www.youtube.com/watch?v=f_Gw-usX0z0 here].

=='''Mozilla Servo'''==

Servo<ref>https://github.com/servo/servo</ref> is a Web Browser engine written using the Rust<ref>https://www.rust-lang.org/</ref> programming platform. Servo is an experimental project build that is optimized for new generations of hardware, particularly mobile devices, devices with multi-core processors and those with high-performance GPUs. It's core design principles are focused on optimizing power efficiency along with maximizing parallelism.<ref>https://en.wikipedia.org/wiki/Servo_(layout_engine)</ref>

=='''Rust'''==
Rust is a multi-paradigm, compiled programming language developed by Mozilla Research. The syntax of Rust is similar to C and C++.
Rust has a self hosting compiler, rustc. <ref>https://en.wikipedia.org/wiki/Rust_(programming_language)</ref>

New projects can be created in Rust using [https://doc.rust-lang.org/book/hello-cargo.html Cargo]. Cargo is the package manager for Rust. It also builds the rust code and manages its dependencies.<ref>http://siciarz.net/24-days-rust-cargo-and-cratesio/</ref>

A new Rust project can be created using the command:

''$ cargo new project_name''

===Testing in Rust===

Cargo will automatically generate a simple test when you make a new project. This new test function can be found in src/lib.rs. #[test] attribute indicates that a given function is a test function.<ref>https://doc.rust-lang.org/book/testing.html</ref>

The standard format for test functions is:

<nowiki>#[test]</nowiki> 

fn test_method() { 
 
}

The tests can be run using the following command:

''$ cargo test''

=='''Unicode Bidirectional Algorithm'''==
The Unicode Standard prescribes a memory representation order of text for browsers known as logical order.But the order they display text is different and is called the visual order.
When text is displayed horizontally, most scripts display the characters from left to right.However in case of languages like Arabic, Hebrew etc. the ordering is from right to left.Also, they have digits that are displayed from left to right.So, the text is bidirectional in nature.In addition, these languages may also have embedded in them, letters from scripts that are displayed from left to right.
To remove any ambiguities that may arise the Unicode Bidirectional Algorithm provides a set of rules which are used by a web-browser to produce the correct order at the time of display.

=='''External Links'''==
[https://github.com/servo/servo/wiki/Design Servo Design]

=='''References'''==
<references/>