1fc09ad39569e9eefc0bd307abb357bccf2a45f7
[coldcallbot-discord.git] / assessment_and_tracking / README
1 I don't expect that these will necessary work without
2 modification. It's a good idea to go line-by-line through these to
3 make sure they are doing what *you* want and that you agree with the
4 assessment logic built into this.
5
6 Daily Process
7 ======================================
8
9 After class, you will have two new files created that will be named
10 like this (with today's date):
11
12     attendance-2020-10-05.tsv
13     call_list-2020-10-05.tsv
14
15 Each day, you need to open up "call_list-YYYY-MM-DD.tsv" and edit the
16 final two columns. The first columns `answered` means that the person
17 responded and answered the question (i.e., they were present in the
18 room but away from their computer and unresponsive). This is almost
19 always TRUE but would be FALSE if the student were missing.
20
21 The final column `assessment` is GOOD, FAIR, or BAD in my rubric. I've
22 detailed what that means on this page:
23
24 https://wiki.communitydata.science/User:Benjamin_Mako_Hill/Assessment#Rubric_for_case_discussion_answers
25
26 I take notes on student answers on paper during class (typically I
27 only note down non "GOOD" answers) and then add these to the sheet
28 immediately after class.
29
30 I keep my entire data directory in git and I'd recommend that you do
31 too.
32
33 Other Notes
34 ======================================
35
36 1.
37
38 These scripts rely on a file in this repository called
39 `data/student_information.csv` which I have set to be downloaded
40 automatically from a Google form using a 1-line wget command.
41
42 For reference, that file has the following column labels (this is the
43 full header, in order):
44
45     Timestamp
46     Your UW student number
47     Name you'd like to go by in class
48     Your Wikipedia username
49     Your username on the class Discord server
50     Preferred pronouns
51     Anything else you'd like me to know?
52
53 2.
54
55 The scripts in this directory are meant to be run or sourced *from*
56 the data directory. As in:
57
58     $ cd ../data
59     $ R --no-save < ../assessment_and_tracking/track_participation.R
60
61 3.
62
63 There are three files here:
64
65 track_enrolled.R:
66
67     This file keeps track of who is in Discord, who is enrolled for
68     the class, etc. This helps me remove people from the
69     student_informaiton.csv spreadsheet who are have dropped the
70     class, deal with users who change their Discord name, and other
71     things that the scripts can't deal with automatically.
72
73     This all need to be dealt with manually, one way or
74     another. Sometimes by modifying the script, sometimes by modifying
75     the files in the data/ directory.
76
77     This requires an additional file called
78     `myuw-COM_482_A_autumn_2020_students.csv` which is just the saved
79     CSV from https://my.uw.edu which includes the full class list. I
80     download this one manually.
81
82 track_participation.R:
83
84     This file generates histograms and other basic information about
85     the distribution of participation and absences. I've typically run
86     this weekly after a few weeks of the class and share these images
87     with students at least once or twice in the quarter.
88
89     This file is also sourced by compute_final_case_grades.R.
90
91 compute_final_case_grades.R:
92
93     You can find a narrative summary of my assessment process here:
94
95     https://wiki.communitydata.science/User:Benjamin_Mako_Hill/Assessment#Overall_case_discussion_grade
96
97     This also requires the registration file (something like
98     `myuw-COM_482_A_autumn_2020_students.csv`) which is described
99     above.
100
101 4.
102
103 A bunch of things in these scripts assumes a UW 4.0 grade scale. I
104 don't think it should be hard to map these onto some other scale, but
105 that's an exercise I'll leave up to those that want to do this.

Community Data Science Collective || Want to submit a patch?