Skip to content

Commit d968611

Browse files
CodingBashclaude
andcommitted
docs: CLI section in README (§4.5)
Concrete flat-arg example for `crispr-correct map` + `crispr-correct count`. Mirrors the Python ParsingConfig fields 1:1 — no config file / YAML. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 99c68a5 commit d968611

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,41 @@ Intermediate save utilities (e.g. `cam.utility.save_or_load_pickle`) remain avai
286286

287287
---
288288

289+
## Command-line interface (v0.1.0)
290+
291+
The package registers a `crispr-correct` console script with two subcommands. All flags mirror the Python `ParsingConfig` fields 1:1 (field names with `_``-`) — no config file, no YAML.
292+
293+
```bash
294+
# Map
295+
crispr-correct map \
296+
--r1 R1.fq.gz \
297+
--r2 R2.fq.gz \
298+
--library library.tsv \
299+
--out result.pickle \
300+
--protospacer-start-position 0 --protospacer-length 20 \
301+
--is-protospacer-r1 --no-revcomp-protospacer \
302+
--protospacer-hamming-threshold-strict 7 \
303+
--surrogate-start-position 0 --surrogate-length 32 \
304+
--no-is-surrogate-r1 --revcomp-surrogate \
305+
--surrogate-hamming-threshold-strict 10 \
306+
--guide-barcode-pattern-regex '_([^_ ]+)[\s+]' \
307+
--is-guide-barcode-header --revcomp-guide-barcode \
308+
--guide-barcode-hamming-threshold-strict 2 \
309+
--retain-inference-results \
310+
--cores 4
311+
312+
# Emit one tier's count Series as TSV
313+
crispr-correct count \
314+
--in result.pickle \
315+
--out counts.tsv \
316+
--tier protospacer_match_surrogate_match_barcode_match \
317+
--strategy ambiguous_accepted_umi_noncollapsed_counterseries
318+
```
319+
320+
Repeat `--r1` / `--r2` for multi-file input. Boolean flags use `--flag/--no-flag` convention. Run `crispr-correct map --help` for the full flag list.
321+
322+
---
323+
289324
## Testing
290325

291326
This repository ships with a test suite under `../tests/` (one directory up from the package). Three layers of coverage:

0 commit comments

Comments
 (0)