clean up outputs and readme

README.md

@@ -1,16 +1,20 @@
 # Canvas Rubric
-Download Assignments and Quiz rubric scores (and comments, only for Assignments right now) .
+Download Assignments and Quiz rubric scores (and comments, only for Assignments right now).
+
+A canvas submission has two scores: the Submission Score and the Rubric Total Score. These may be provided by different users (i.e a TA uses the rubric and the Instructor gives a final score). The data provided here only indicates the Rubric Grader which may be different than the provider of the Submission Score.
 
 Canvas Rubric returns a CSV with the following headers:
 * Student Name
-* Student Number
-* Section Number
-* TA Name
-* TA Student Number
-* Total grade on assignment
-* Link to download assignment submission
+* Student Number (SIS ID)
+* Student Canvas ID
+* Section Name
+* Submission State
+* Submission Score [the score given to the submission, seperate from the rubric]
+* Rubric Grader Name
+* Rubric Grader Role
+* Rubric Total Score [the total score from the rubric]
 * Each individual component of the rubric (grade and comments)
-* Overall comments made by TA/Instructor only (student comments are filtered out)
+* Overall submission comments made by non-students only (student comments are filtered out)
 
 ## Getting Started
 

writeToCSV.js

@@ -16,16 +16,16 @@ const writeToCSV = (data, filename) => {
     'student_name',
     'student_number',
     'student_canvas_id',
-    'student_role',
+    //'student_role',
     'section_name',    
     'submission_state',
     'submission_score',
-    'grader_id',
-    'grader_name',
-    'grader_role',
-    'rubricScore',
-    'rubricGraderName',
-    'rubricGraderRole'
+    //'grader_id',
+    //'grader_name',
+    //'grader_role',
+    'rubric_grader_name',
+    'rubric_grader_role',
+    'total_rubric_score',
   ]
 
   data[0].rubricData.forEach((_, i) => {
@@ -42,16 +42,16 @@ const writeToCSV = (data, filename) => {
       escapeComment(studentData.userName),
       studentData.userSISID,
       studentData.userCanvasID,
-      studentData.enrollmentType,
+      //studentData.enrollmentType,
       studentData.sectionName,
       studentData.submissionState,
       studentData.submissionScore,
-      studentData.graderId,
-      escapeComment(studentData.graderName),
-      studentData.graderRole,
-      studentData.rubricScore,
+      //studentData.graderId,
+      //escapeComment(studentData.graderName),
+      //studentData.graderRole,
       escapeComment(studentData.rubricGraderName),
-      studentData.rubricGraderRole
+      studentData.rubricGraderRole,
+      studentData.rubricScore,
     ]
 
     studentData.rubricData.forEach(({ points, comments }) => {
@@ -60,7 +60,6 @@ const writeToCSV = (data, filename) => {
     })
 
     studentData.overallComments.forEach(comments => row.push(escapeComment(comments)))
-    //console.log(row)
     append(csv, row)
   })
 }