Skip to content

Commit 1addab8

Browse files
Document sample-ID support for --zscore-controls in README and Z-score docs.
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent dbe421d commit 1addab8

2 files changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ virasign --help
123123

124124
- **Z-score (optional)**: Background-correct hits using water controls. See [`docs/Z_SCORE.md`](docs/Z_SCORE.md).
125125
- `--zscore`: Z-score computation (default: `true`, auto-detect water controls by name: `water`/`h2o`/`h20`, or `NC`/`CN` + digits e.g. `NC1`/`CN2`).
126-
- `--zscore-controls`: Override auto-detection with exact input paths (example: `--zscore-controls /path/water1.fastq.gz,/path/water2.fastq.gz` or `--zscore-controls water_controls.txt` with one path per line).
126+
- `--zscore-controls`: Override auto-detection with sample IDs and/or FASTQ paths (≥2 controls). Examples: `--zscore-controls H20_1,H20_2,BG_1,BG_2` (sample folder / samplesheet names), `--zscore-controls /path/water1.fastq.gz,/path/water2.fastq.gz`, or `--zscore-controls water_controls.txt` (one sample ID or path per line). When set, replaces auto-detect. Control samples show `-` in the Z-score column (they are used only to score other samples).
127127

128128
- **RVDB clustering (optional)**: Cluster RVDB to reduce database size and speed up runtime.
129129
- `--enable-clustering`: Enable clustering for RVDB (default: off).

docs/Z_SCORE.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,20 @@ By comparing each virus to your water controls in the same run, the Z-score answ
2323
- Water controls are auto-detected when the sample name (case-insensitive):
2424
- contains `water`, `h2o`, or `h20`, or
2525
- has `NC`/`CN` immediately followed by digits (e.g. `NC1`, `CN2`, `NC1.fastq`), so bare `NC`/`CN` in clinical names do not match.
26-
- You can override auto-detection with exact input FASTQ paths:
26+
- You can override auto-detection with **sample IDs** (folder / samplesheet names) and/or exact FASTQ paths (≥2 controls):
2727

2828
```bash
29+
# Sample IDs (recommended when running via Metatropics samplesheet / POD5.csv)
30+
virasign -i input_dir --zscore-controls H20_1,H20_2,BG_1,BG_2
31+
32+
# Exact FASTQ paths
2933
virasign -i input_dir --zscore-controls /path/to/water1.fastq.gz,/path/to/water2.fastq.gz
34+
35+
# Or a text file (one sample ID or path per line)
36+
virasign -i input_dir --zscore-controls water_controls.txt
3037
```
3138

32-
When `--zscore-controls` is provided, Virasign does not use auto-detection (so you can exclude some “H2O_*” samples intentionally).
39+
When `--zscore-controls` is provided, Virasign does not use auto-detection (so you can exclude some “H2O_*” samples intentionally). Control samples themselves show `-` in the Z-score column; numeric Z-scores are only reported for non-control samples.
3340

3441
---
3542

0 commit comments

Comments
 (0)