nci-get-assignment-grades.1

   1 .Dd 2016-06-12
   2 .Dt NCI-GET-ASSIGNMENT-GRADES 1
   3 .Os
   4 .Sh NAME
   5 .Nm nci-get-assignment-grades
   6 .Nd Print grading information for some assignments from a Canvas installation
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Fl c
  10 .Ar course-id
  11 .Oo
  12 .Fl A
  13 |
  14 .Fl a
  15 .Ar assignment-id
  16 .Oo
  17 .Fl a
  18 .Ar assignment-id
  19 .Oo ...
  20 .Oc
  21 .Oc
  22 .Oc
  23 .Oo
  24 .Fl p
  25 .Oc
  26 .Oo
  27 .Fl t
  28 .Oc
  29 .Sh DESCRIPTION
  30 .Nm
  31 connects to a Canvas installation as described at
  32 .Xr nci 1
  33 and retrieves all submissions for a given
  34 .Ar course-id
  35 and all provided
  36 .Ar assignment-id Ns s
  37 .Pq or all assignments .
  38 The printed information will be in CSV format
  39 .Pq see RFC 4180 .
  40 The encoding is whatever is returned by the Canvas installation, which
  41 is probably UTF-8. There will be header line, of the form
  42 .Pp
  43 .Bl -column
  44 .It Qo Name Qc , Ta Qo ID Qc , Ta Qo Ar course-id Ns :  Ns Ar assignment-id  Po Ar assignment-name Pc Qc ,  Ta ...
  45 .El
  46 .Pp
  47 Following this will be one line for every student enrolled in
  48 .Ar course-id .
  49 The current grade for each assignment will be listed in the relevant
  50 column. A blank entry indicates that no grade is yet listed. The letters
  51 .Dq EX
  52 indicate that the student has been excused from this assignment.
  53 .Sh OPTIONS
  54 .Bl -tag -width Ds
  55 .It Fl c
  56 The
  57 .Ar course-id ,
  58 as returned by
  59 .Xr nci-list-courses 1 .
  60 .It Fl a
  61 An
  62 .Ar assignment-id ,
  63 as returned by
  64 .Xr nci-list-assignments 1 .
  65 Mutually exclusive with
  66 .Fl A .
  67 .It Fl A
  68 Retrieve all assignments.  Mutually exclusive with
  69 .Fl a .
  70 .It Fl t
  71 Include a column for the current total grade in the course, as well
  72 as one for computed letter grades. Ungraded assignments are treated as
  73 zeroes when performing this calculation.
  74 .It Fl p
  75 Include a column for the partial total grade in the course, as well
  76 as one for partial computed letter grades. Ungraded assignments are
  77 ignored when performing this calculation. See
  78 .Sx BUGS.
  79 .El
  80 .Sh BUGS
  81 The
  82 .Fl p
  83 and
  84 .Fl t
  85 arguments seem redundant. They differ in how assignments with empty
  86 .Pq Dq
  87 grades are handled. Even after an assignment's due date has passed,
  88 it will still be ignored by
  89 .Fl p
  90 unless a grade has been explicitly given. Even before an assignment's
  91 due date has passed, it will be treated as zero by
  92 .Fl t .
  93 This means that there is no way to request
  94
  95 .Dl Dq Give me students' current total grades in the course, treating empty assignments as zeroes but only considering assignments with due dates that have passed.
  96 .Sh EXAMPLES
  97 .Dl % nci-get-assignment-grades -c 1180637 -a 4089590 -a 4089592
  98 .Dl Qo Name Qc , Qo ID Qc , Qo 1180637:4089590 (Exam 1) Qc , Qo 1180637:4089592 (Exam 3) Qc
  99 .Dl Qo Arnold, Benedict Qc , Qo 399414 Qc , Qo 83.4 Qc , Qo  Qc
 100 .Dl Qo Burr, Aaron Qc , Qo 348223 Qc , Qo 94 Qc , Qo 79 Qc
 101 .Dl Qo Κασσάνδρα Qc , Qo 3944812 Qc , Qo Qc , Qo EX Qc
 102
 103 .Dl % nci-get-assignment-grades -c 1180637 -A
 104 .Dl Qo Name Qc , Qo ID Qc , Qo 1180637:4089590 (Exam 1) Qc , Qo 1180637:4089591 (Exam 2) Qc , Qo 1180637:4089592 (Exam 3) Qc
 105 .Dl Qo Arnold, Benedict Qc , Qo 399414 Qc , Qo 83.4 Qc , Qo 99 Qc , Qo  Qc
 106 .Dl Qo Burr, Aaron Qc , Qo 348223 Qc , Qo 94 Qc , Qo Qc , Qo 79 Qc
 107 .Dl Qo Κασσάνδρα Qc , Qo 3944812 Qc , Qo Qc , Qo 83 Qc , Qo EX Qc
 108
 109 .Dl % nci-get-assignment-grades -c 1180637 -t
 110 .Dl Qo Name Qc , Qo ID Qc , Qo Total Qc , Qo Letter Grade Qc
 111 .Dl Qo Arnold, Benedict Qc , Qo 399414 Qc , Qo 60 Qc , Qo A Qc
 112 .Dl Qo Burr, Aaron Qc , Qo 348223 Qc , Qo 57.6  Qc , Qo B Qc
 113 .Dl Qo Κασσάνδρα Qc , Qo 3944812 Qc , Qo 41.5 Qc , Qo B Qc
 114 .Sh SEE ALSO
 115 .Xr nci 1
 116 .Xr nci-list-assignments 1
 117 .Xr nci-list-courses 1
 118 .Xr nci-put-assignment-grades 1
 119 .Sh AUTHORS
 120 .An S. Gilles Aq Mt sgilles@math.umd.edu