Skip to content

Commit fd91191

Browse files
committed
Update student instructions with interactive script workflow
- Added STEP 3: python3 answer_assignment.py - Added STEP 4: git add/commit/push workflow - Clarified class dataset (everyone analyzes same data) - Added auto-grading check instructions (Actions tab) - Updated both README.md and start_here.md - Complete 4-step workflow clearly documented Now students know: 1. Run tutorial 2. Run analysis 3. Answer questions interactively 4. Push to GitHub for auto-grading
1 parent 0727108 commit fd91191

2 files changed

Lines changed: 45 additions & 16 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,16 @@ See **[start_here.md](start_here.md)** for the complete beginner's guide.
4040
# STEP 1: Learn with test data (15 min)
4141
./tutorial.sh
4242

43-
# STEP 2: Analyze YOUR mosquito sequences (5 min)
43+
# STEP 2: Analyze the class mosquito sequences (5 min)
4444
./run-analysis.sh
4545

46-
# STEP 3: Fill out assignment.md
46+
# STEP 3: Answer questions interactively (10 min)
47+
python3 answer_assignment.py
48+
49+
# STEP 4: Submit to GitHub (auto-graded!)
50+
git add answers.json results/
51+
git commit -m "Complete assignment"
52+
git push origin main
4753
```
4854

4955
### For Instructors

start_here.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,9 @@ This teaches you all 5 steps using example data. **DO NOT SKIP THIS!**
8484

8585
---
8686

87-
### STEP 2: Analyze Your Own Mosquito Sequences
87+
### STEP 2: Analyze the Class Mosquito Sequences
8888

89-
**Put your .ab1 files in the data folder:**
90-
```bash
91-
cp ~/Desktop/*.ab1 data/student_sequences/
92-
```
89+
**Important:** Everyone analyzes the **same class dataset**. The .ab1 files are already in `data/student_sequences/`
9390

9491
**Run the complete analysis:**
9592
```bash
@@ -107,23 +104,49 @@ Your results will be in: `results/my_analysis/`
107104

108105
---
109106

110-
### STEP 3: Fill Out Assignment
107+
### STEP 3: Answer Assignment Questions
108+
109+
**Run the interactive question script:**
110+
```bash
111+
python3 answer_assignment.py
112+
```
113+
114+
This script will:
115+
- Guide you through your analysis results
116+
- Ask questions about QC, BLAST, and phylogeny
117+
- Save your answers to `answers.json`
118+
119+
It's interactive and easy - just follow the prompts!
120+
121+
---
122+
123+
### STEP 4: Submit to GitHub
111124

112-
Open these files and answer the questions in `assignment.md`:
125+
**Commit and push your work:**
126+
```bash
127+
git add answers.json results/
128+
git commit -m "Complete DNA barcoding analysis"
129+
git push origin main
130+
```
113131

114-
- `results/my_analysis/01_qc/qc_report.html` - How many sequences passed?
115-
- `results/my_analysis/04_phylogeny/tree.png` - What species cluster together?
116-
- `results/my_analysis/05_blast/identification_report.html` - What species did you find?
132+
**Check auto-grading:**
133+
1. Go to your GitHub repository
134+
2. Click the "Actions" tab
135+
3. Look for ✅ (passed) or ❌ (failed)
136+
4. If failed, click on it to see feedback
117137

118138
---
119139

120140
## That's It!
121141

122-
**The workflow in 3 commands:**
142+
**The complete workflow:**
123143
```bash
124-
./tutorial.sh # Learn (15 min)
125-
./run-analysis.sh # Analyze your data (5 min)
126-
# Fill out assignment.md
144+
./tutorial.sh # STEP 1: Learn (15 min)
145+
./run-analysis.sh # STEP 2: Analyze class data (5 min)
146+
python3 answer_assignment.py # STEP 3: Answer questions (10 min)
147+
git add answers.json results/
148+
git commit -m "Complete assignment"
149+
git push origin main # STEP 4: Submit (auto-graded!)
127150
```
128151

129152
**Need help?**

0 commit comments

Comments
 (0)