renamed the README file
This commit is contained in:
parent
9c4f81c30a
commit
0ecadc51eb
@ -1,11 +1,43 @@
|
||||
I don't expect that these will necessary work without
|
||||
modification. It's a good idea to go line-by-line through these to
|
||||
make sure they are doing what *you* want and that you agree with the
|
||||
assessment logic built into this.
|
||||
Setting up the Discord Bot
|
||||
======================================
|
||||
|
||||
I run the Discord boy from my laptop. It requires the discord Python
|
||||
module available in PyPi and installable like:
|
||||
|
||||
$ pip3 install discord
|
||||
|
||||
I don't have details on how I set up my own Discord bot and/or invited
|
||||
it to my server but I hope you'll add to this file as you do this and
|
||||
figure out what needs to happen.
|
||||
|
||||
Using the Cold Call Bot
|
||||
======================================
|
||||
|
||||
1. All students must have the role "Student" in Discord. If they do
|
||||
not have the roll, they will not be called upon.
|
||||
|
||||
2. The "classroom" is the "Classroom Voice" channel. This is currently
|
||||
hard coded.
|
||||
|
||||
3. The bot has only one command: "$next" which calls a person and
|
||||
records this information in the logs. You can run this command in
|
||||
any channel that the bot has access to (e.g., #bot-commands) but I
|
||||
do it a public channel called "#classroom-questions" so that
|
||||
students can watch it operate.
|
||||
|
||||
|
||||
Daily Process
|
||||
======================================
|
||||
|
||||
You need to start the bot from the laptop each day. I do that by:
|
||||
|
||||
$ ./coldcallboy.py
|
||||
|
||||
The bot will run in the terminal, print out data as it works including
|
||||
detailed weights as it goes, and it will record data into files in the
|
||||
/data/ directory.
|
||||
|
||||
|
||||
After class, you will have two new files created that will be named
|
||||
like this (with today's date):
|
||||
|
||||
@ -30,10 +62,13 @@ immediately after class.
|
||||
I keep my entire data directory in git and I'd recommend that you do
|
||||
too.
|
||||
|
||||
Other Notes
|
||||
======================================
|
||||
I don't expect that these will necessary work without
|
||||
modification. It's a good idea to go line-by-line through these to
|
||||
make sure they are doing what *you* want and that you agree with the
|
||||
assessment logic built into this.
|
||||
|
||||
1.
|
||||
Assessment and Tracking
|
||||
======================================
|
||||
|
||||
These scripts rely on a file in this repository called
|
||||
`data/student_information.csv` which I have set to be downloaded
|
||||
@ -50,17 +85,13 @@ full header, in order):
|
||||
Preferred pronouns
|
||||
Anything else you'd like me to know?
|
||||
|
||||
2.
|
||||
|
||||
The scripts in this directory are meant to be run or sourced *from*
|
||||
the data directory. As in:
|
||||
|
||||
$ cd ../data
|
||||
$ R --no-save < ../assessment_and_tracking/track_participation.R
|
||||
|
||||
3.
|
||||
|
||||
There are three files here:
|
||||
There are three files in that directory:
|
||||
|
||||
track_enrolled.R:
|
||||
|
||||
@ -98,8 +129,7 @@ compute_final_case_grades.R:
|
||||
`myuw-COM_482_A_autumn_2020_students.csv`) which is described
|
||||
above.
|
||||
|
||||
4.
|
||||
|
||||
A bunch of things in these scripts assumes a UW 4.0 grade scale. I
|
||||
don't think it should be hard to map these onto some other scale, but
|
||||
that's an exercise I'll leave up to those that want to do this.
|
||||
One final note: A bunch of things in these scripts assumes a UW 4.0
|
||||
grade scale. I don't think it should be hard to map these onto some
|
||||
other scale, but that's an exercise I'll leave up to those that want
|
||||
to do this.
|
||||
Loading…
Reference in New Issue
Block a user