Skip to content

Commit b61a08e

Browse files
authored
[Documentation:RainbowGrades] Finish Customization Basics (#615)
Complete the guide for the configuration of customization.json found in Instructor > Course Settings > Rainbow Grades > Customization Basics (https://submitty.org/instructor/course_settings/rainbow_grades/customization_basics)
1 parent 290de97 commit b61a08e

File tree

1 file changed

+80
-8
lines changed

1 file changed

+80
-8
lines changed

_docs/instructor/course_settings/rainbow_grades/customization_basics.md

+80-8
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,26 @@ It can contain the following:
2626
* ``"instructor_notes"``: Shows notes for early warnings, plagiarism, etc. only to the instructor
2727
* ``"grade_summary"``: Shows the overall score and score for each syllabus bucket (e.g. Homework)
2828
* ``"grade_details"``: Shows the score for each gradeable
29+
* ``"section"``: Show the students' registration section.
30+
* ``"messages"``: Show a text message at the top of the page.
2931
* ``"final_grade"``: Shows final grade letters and some statistics about the final grade distribution.
32+
* ``"manual_grade"``: Manually assign final grades to specific students.
3033
* ``"exam_seating"``: Shows exam seating assignments. To display the assignment on the Submitty course homepage,
3134
the instructor should make sure "Display Rainbow Grades Custom Message" is enabled in "Course Settings" on the Submitty
3235
course page.
3336
* ``"display_rank_to_individual"``: Shows each student's rank in the course, independent of section.
3437

38+
```json
39+
"display": [
40+
"grade_summary",
41+
"grade_details",
42+
"section",
43+
"messages",
44+
"final_grade",
45+
"manual_grade"
46+
]
47+
```
48+
3549
* **field:** ``"display_benchmark"``
3650
**type:** _array of strings_
3751
**REQUIRED** if using ``"curve"`` in ``"gradeables"`` described below
@@ -43,6 +57,18 @@ It can contain the following:
4357
* ``"lowest_a-``, ``"lowest_b-"``, ``"lowest_c-"``, ``"lowest_d"``: Based on curves, the lowest scores that will earn
4458
the name of the benchmark.
4559

60+
```json
61+
"display_benchmark": [
62+
"average",
63+
"stddev",
64+
"perfect",
65+
"lowest_a-",
66+
"lowest_b-",
67+
"lowest_c-",
68+
"lowest_d"
69+
]
70+
```
71+
4672
* **field:** ``"benchmark_percent"``
4773
**type:** _associative array / mapping from string to float_
4874
**REQUIRED** if using ``"curve"`` in ``"gradeables"`` described below, or if any grade-letter benchmarks are used in ``"display_benchmark"`` above.
@@ -51,6 +77,16 @@ It can contain the following:
5177
necessary to obtain that grade. For example to require an 82% for an A-, there should be an entry in the ``"benchmark_percent"`` array:
5278
``"lowest_a-": 0.82``
5379

80+
To display all benchmarks, include the following:
81+
```json
82+
"benchmark_percent": {
83+
"lowest_a-": 0.9,
84+
"lowest_b-": 0.8,
85+
"lowest_c-": 0.7,
86+
"lowest_d": 0.6
87+
}
88+
```
89+
5490
* **field:** ``"section"``
5591
**type:** _associative array / mapping from string to string_
5692
**REQUIRED**
@@ -60,34 +96,70 @@ It can contain the following:
6096
this array will be treated as invalid and ignored. These labels are only displayed
6197
on the instructor's `output.html`.
6298

99+
```json
100+
"section": {
101+
"1": "1",
102+
"2": "2",
103+
"3": "3",
104+
"4": "4",
105+
"5": "5",
106+
"6": "6",
107+
"7": "7",
108+
"8": "8",
109+
"9": "9",
110+
"10": "10"
111+
}
112+
```
113+
63114
* **field:** ``"messages"``
64115
**type:** _array of strings_
65116

66117
These messages will be displayed at the top of the instructor summary and each
67118
student's individual Rainbow Grades report.
68119

120+
```json
121+
"messages": [
122+
"Example message"
123+
]
124+
```
125+
69126
* **field:** ``"final_cutoff"``
70127
**type:** _associative array / mapping from string to float_
71128
**REQUIRED** if using ``"final_grade"`` in ``"display"``
72129

73130
Each grade letter that you want should be associated with the minimum overall semester score required to get that grade.
74-
This array is unrelated to benchmarks.
131+
This array is unrelated to benchmarks. For example:
132+
133+
```json
134+
"final_cutoff" : {
135+
"A": 93.0,
136+
"A-": 90.0,
137+
"B+": 87.0,
138+
"B": 83.0,
139+
"B-": 80.0,
140+
"C+": 77.0,
141+
"C": 73.0,
142+
"C-": 70.0,
143+
"D+": 67.0,
144+
"D": 63.0
145+
}
146+
```
75147

76148
* **field:** ``"manual_grade"``
77-
**type:** _associative array / mapping from string to associative array_
149+
**type:** _array of associative arrays_
78150

79-
For each student that you want to assign a manual grade to, their id must
80-
be mapped to an associative array with a field ``"grade"`` mapped to a string
81-
with the letter grade you want to give them, and ``"note"`` containing any note
82-
about the adjustment. The note is only visible to the instructor. For example,
151+
For each student that you want to assign a manual grade to, add an item to
152+
``"manual_grade"`` with fields ``"user"``, ``"grade"``, and ``"note"`` containing
153+
any note about the adjustment. The note is only visible to the instructor. For example,
83154
to give user ``smithj`` a grade lettter of ``D`` with a reason of
84155
``"Put in extraordinary effort."``:
85156

86157
```json
87-
"smithj" : {
158+
"manual_grade" : [{
159+
"user":"smithj",
88160
"grade": "D",
89161
"note": "Put in extraordinary effort."
90-
}
162+
}]
91163
```
92164

93165
* **field:** ``"warning"``

0 commit comments

Comments
 (0)