Skip to content

Commit 45db52a

Browse files
committed
Explain two ways to run analysis - automated scripts vs individual modules
Added detailed explanation for beginners: start_here.md: - New section: '🎯 Two Ways to Run the Analysis' - Option 1: Automated scripts (./tutorial.sh, ./run-analysis.sh) - RECOMMENDED - Option 2: Individual module commands - for learning - Explained what docker commands mean line-by-line: * docker run = run container * -v = share folders * python3 modules/... = run specific script * data/student_sequences/ = input * results/my_analysis/ = output - Pros/cons of each approach assignment.md: - Added '💡 How to Run the Analysis' section at top of Part 1 - Clarified: Can use ./run-analysis.sh OR run steps individually - Emphasized automated script is easiest - Explained individual commands are for understanding/re-running steps - Reminded: commands run in VSCode terminal, Docker is automatic Benefits: - First-time students understand they have options - Know what's happening 'under the hood' - Can troubleshoot by re-running individual steps - Less intimidating - scripts do the work!
1 parent fc17cc3 commit 45db52a

2 files changed

Lines changed: 74 additions & 0 deletions

File tree

assignment.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,24 @@ The dataset includes:
4848
- Reverse reads (sample names ending in R)
4949
- Example: AT-HV1F and AT-HV1R are a pair
5050

51+
---
52+
53+
### 💡 How to Run the Analysis
54+
55+
**OPTION 1 (RECOMMENDED): Use the automated script**
56+
```bash
57+
./run-analysis.sh
58+
```
59+
This runs all 6 steps below automatically. **This is the easiest way!**
60+
61+
**OPTION 2: Run each step individually (shown below)**
62+
63+
The commands below show you what happens in each step. You can run them one by one if you want to understand the process better, or if you need to re-run just one step.
64+
65+
**These commands run in your VSCode terminal on your computer** - Docker is called automatically.
66+
67+
---
68+
5169
### Step 1: Quality Control (10 points)
5270

5371
Check which sequences are good enough to use:

start_here.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,62 @@ ls
104104

105105
---
106106

107+
## 🎯 Two Ways to Run the Analysis
108+
109+
You can run the analysis in two ways:
110+
111+
### Option 1: Automated Scripts (RECOMMENDED for beginners)
112+
113+
**Easy, one-command approach:**
114+
```bash
115+
./tutorial.sh # Runs all 5 steps automatically
116+
./run-analysis.sh # Runs all 5 steps on your data
117+
```
118+
119+
**Pros:**
120+
- ✅ Simple - just one command
121+
- ✅ Everything runs automatically
122+
- ✅ Can't mess up the order
123+
124+
**This is what most students should use!**
125+
126+
### Option 2: Run Each Module Separately (For learning)
127+
128+
**If you want to understand what's happening, you can run each step individually.**
129+
130+
The scripts use commands like this:
131+
```bash
132+
docker run --rm --entrypoint="" -v $(pwd):/workspace -w /workspace \
133+
cosmelab/dna-barcoding-analysis:latest \
134+
python3 modules/01_quality_control/qc_chromatograms.py \
135+
data/student_sequences/ \
136+
results/my_analysis/qc/ \
137+
--open
138+
```
139+
140+
**What does this mean?**
141+
- `docker run` = Run the Docker container
142+
- `-v $(pwd):/workspace` = Share your current folder with Docker
143+
- `python3 modules/01_quality_control/qc_chromatograms.py` = Run the QC Python script
144+
- `data/student_sequences/` = Input: where your .ab1 files are
145+
- `results/my_analysis/qc/` = Output: where results go
146+
- `--open` = Automatically open the HTML report
147+
148+
**All individual commands are in `assignment.md` if you want to run steps one by one.**
149+
150+
**Pros:**
151+
- ✅ Understand each step
152+
- ✅ Can re-run just one step if needed
153+
- ✅ See exactly what's happening
154+
155+
**Cons:**
156+
- ❌ More typing
157+
- ❌ Easy to miss a step or mess up the order
158+
159+
**For this assignment, we recommend using the automated scripts (Option 1).** But if you're curious about how things work, check out `assignment.md` for the individual commands!
160+
161+
---
162+
107163
### OPTIONAL: Interactive Terminal (Advanced)
108164

109165
**Want a fancy terminal with colorful output?** The container includes a beautiful Zsh shell setup!

0 commit comments

Comments
 (0)