Merge pull request #149 from mishaschwartz/v2.1.1

V2.1.1

Instructor-Guide--Assignments--Marking--Grading-View.md

@@ -77,9 +77,12 @@ In the above image, an annotation is about to be made for the letter 'e'.
 Once you have selected a section, click on the "CREATE ANNOTATION" button to begin writing:
 
 This will open the following modal:
+
 ![Create Annotation Window](images/grade-view-annotation-modal.png)
 
-From this window you will be able to type out a comment for the students to see. Since the annotation field supports basic LaTeX and markdown commands, a preview is available under the text field so that you may see what your annotation will look like when released. Don't worry if it isn't perfect as there is an option to edit later! An annotation category may be specified from the drop-down list under "Annotation Category". (See the [Annotations](Instructor-Guide--Assignments--Deductive-Annotations.md) page for information on creating annotation categories) Once finished, be sure to click on the "Create Annotation" button to save your annotation!
+![Create Annotation Window Latex Tab](images/grade-view-annotation-modal-latex.png)
+
+From this window you will be able to type out a comment for the students to see. Since the annotation field supports basic LaTeX and markdown commands, a preview is in the second tab so that you may see what your annotation will look like when released. Don't worry if it isn't perfect as there is an option to edit later! An annotation category may be specified from the drop-down list under "Annotation Category". (See the [Annotations](Instructor-Guide--Assignments--Deductive-Annotations.md) page for information on creating annotation categories) Once finished, be sure to click on the "Create Annotation" button to save your annotation!
 
 ### Quick Annotations
 

Instructor-Guide--Marks-Spreadsheets--Assigning-Marks.md

@@ -6,6 +6,7 @@
     - [Columns](#columns)
     - [Releasing Marks](#Releasing-marks)
     - [Unreleasing Marks](#unreleasing-marks)
+    - [Summary Statistics](#summary-statistics)
 - [Graders Tab](#graders-tab)
 
 > :spiral_notepad: **NOTE:** Make sure you have read the [set-up page](Instructor-Guide--Marks-Spreadsheets--Setting-Up.md) for marks spreadsheets before proceeding with this section.
@@ -44,6 +45,55 @@ The "State" column should now say "Released" for all the marks that have been su
 
 Once a spreadsheet row has been released to a student, the student's column marks may not be changed. However, if you wish to modify their marks, you may unrelease their marks by selecting the rows again and clicking the "Unrelease Marks" button.
 
+### Summary Statistics
+
+Clicking on the "Summary Statistics" tab in the top left corner of the Grades page will take you to the summary statistics view.
+
+![Marks Spreadsheet Summary Tab](images/marks-spreadsheet-grades-summary-tab.png)
+
+Here, you can easily visualize and look at key statistics that summarizes overall student performance on the given marks spreadsheet. This is an enlarged view of the summary statistics you can find on the dashboard.
+
+#### Grades Distribution
+
+In the top left section, you can see a chart that displays the distribution of grades for the given marks spreadsheet.
+
+![Marks Spreadsheet Grade Distribution](images/marks-spreadsheet-grade-distribution.png)
+
+To the right of the grade distribution chart is a set of statistics that give a brief overview of student performance on the given marks spreadsheet. Statistics that are currently shown are:
+
+![Marks Spreadsheet Summary Overview](images/marks-spreadsheet-summary-stats-overview.png)
+
+- **Number of students:** The number of students assigned to this marks spreadsheet.
+- **Number of students graded:** The number of students that have at least one column mark.
+- **Average:** The average total point grade for the given marks spreadsheet.
+- **Median:** The median total grade for the given marks spreadsheet.
+- **Standard deviation:** The total point grade standard deviation for the given marks spreadsheet. In brackets next to this statistic is the standard deviation given as a percentage.
+- **Number of fails:** How many graded students recieved a failing total grade (i.e. recieved a grade under 50%) for the given marks spreadsheet.
+- **Number of zeros:** How many graded students recieved a total grade of zero for the given marks spreadsheet.
+
+> :spiral_notepad: **Note:** In brackets, next to each of the statistics that are shown as a fraction, is the same statistic fraction but displayed as a percentage instead. All marks shown include students that recieve a total grade of zero but does not include students who have a null total grade. Students which have a null grade for certain columns but have at least one valid column mark will have their null grade in the other columns be treated as a zero for the purposes of calculating their total grade
+
+#### Column Grade Distribution
+
+Below the grade distribution chart, you can further analyze the distribution of grades using the column grade distribution graph. This graph shows the distribution of marks given for each column.
+
+![Marks Spreadsheet Column Grade Distribution Graph](images/marks-spreadsheet-column-distribution.png)
+
+Each column corresponds to a colour shown in the labels just above the graph.
+
+To help you get a quick overview of student performance for each column, next to the column distribution graph is a table that shows each column along with the average grade received for that column. Clicking on the drop down arrow next to each column will reveal additional summary statistics for that particular column.
+
+![Marks Spreadsheet Column Summary Stats](images/marks-spreadsheet-column-distribution-stats.png)
+
+The additional column statistics currently shown are:
+
+- **Average:** The average grade received for the given column.
+- **Median:** The median grade received for the given column.
+- **Standard deviation:** The point grade standard deviation for the given column. The percentage standard deviation for the given column is shown in brackets next to this statistic.
+- **Number of zeros:** The number of submissions which recieved a grade of zero on the given column.
+
+> :spiral_notepad: **Note:** All statistics include students that have recieved a valid grade for the given column. This includes students that received a mark of zero.
+
 ## Graders Tab
 
 See [this page](Instructor-Guide--Assignments--Assigning-Graders.md) for instructions on how to assign graders.

Instructor-Guide--Users.md

@@ -29,6 +29,7 @@ The page contains the following fields to be filled out:
 - **User Name:** The student's username (used to log in).
 - **Grace Credits:** The number of grace credits you'd like the student to have (if you'd like them to have none or are not using grace credits enter 0).
 - **Section:** The section the student is in (you may also create a new section from here) (optional).
+- **Status:** The status of the student (default is active).
 
 Once you've filled out the required fields, don't forget to hit save to create your student account!
 
@@ -51,8 +52,8 @@ A count of the number of grace credits a student has left can be seen in the "Gr
 
 Three actions other than assigning grace credits may be performed from the drop down menu:
 
-- **Add to section**: This allows you to add the selected student(s) to the specified lecture section.
-![Add to section](images/users-add-to-section.png)
+- **Update section**: This allows you to update the section for the selected student(s). The available options are a "no section" - if you want to remove the students from their current section - and the existing sections for the course.
+![Update section](images/users-update-section.png)
 
 - **Mark as inactive:** Sets the selected student(s) status to inactive.
 - **Mark as active:** Sets the selected student(s) status to active.

RESTful-API.md

@@ -460,6 +460,47 @@ NOTE: the "AdminRole" type can only be used by AdminUser users
     - user_name (string : user name of a student in this course)
     - grade_entry_items (list of list of strings: the first string is a grade entry item name and the second is an integer to be assigned as a score. For example: `[["Q1", 100], ["Q2", 23]]`)
 
+### GET /api/courses/:course_id/tags
+
+- description: Display all tag information for a given course
+- optional parameters:
+    - [filter](#filter)
+    - [fields](#fields)
+- example response (json):
+
+```json
+[
+  {
+    "id": 20,
+    "name": "tag1",
+    "description": "desc",
+    "creator": "user1",
+    "use": 30,
+  }
+]
+```
+
+### POST /api/courses/:course_id/tags
+
+- description: Create a new tag for a given course
+- required parameters:
+    - assignment_id (integer: id of the assignment of the tag)
+    - name (string)
+- optional parameters:
+    - grouping_id (integer: id of grouping to pair the tag with)
+    - description (string)
+
+### PUT /api/courses/:course_id/tags/:id
+
+- description: Update a given tag
+- optional parameters:
+    - name (string)
+    - description (string)
+
+### DELETE /api/courses/:course_id/tags/:id
+
+- description: Delete a given tag
+
 ### GET /api/courses/:course_id/assignments
 
 - description: Display all assignment information for the given course
@@ -961,6 +1002,18 @@ NOTE: adding feedback files to subdirectories is currently not supported
 ]
 ```
 
+### PUT /api/courses/:course_id/assignments/:assignment_id/groups/:group_id/add_tag
+
+- description: Add a tag to a grouping
+- required parameters:
+    - tag_id (integer)
+
+### PUT /api/courses/:course_id/assignments/:assignment_id/groups/:group_id/remove_tag
+
+- description: Remove a tag from a grouping
+- required parameters:
+    - tag_id (integer)
+
 ### GET /api/courses/:course_id/feedback_files/:id
 
 - description: Download the content of the given feedback file