You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add coverage for the new `--sample-bc-ori {fw,rev}` flag introduced in the
companion PR #199 against `main`:
- Insert the option in the `simpleaf multiplex-quant -h` snippet.
- Add a "Sample barcode orientation" bullet under Resource resolution
explaining the precedence (CLI > preset > alevin-fry default) and the
fw/rev → forward/reverse translation.
- Add an Examples entry showing a 10x Flex v2 Configuration B run.
Refs: #198, #199
Copy file name to clipboardExpand all lines: docs/source/flex-quant-command.rst
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,8 @@ The relevant options (which you can obtain by running ``simpleaf multiplex-quant
53
53
Path to cell barcode whitelist (one barcode per line, overrides chemistry default)
54
54
--expected-ori <EXPECTED_ORI>
55
55
Expected read orientation: fw, rc, or both [default: both]
56
+
--sample-bc-ori <SAMPLE_BC_ORI>
57
+
Sample barcode orientation override: ``fw`` (whitelist matches read as-is) or ``rev`` (reverse-complement the whitelist before lookup). Overrides the chemistry preset's ``sample_bc_ori`` when set; otherwise the preset value (if any) is used. Mirrors the ``--expected-ori`` shorthand [possible values: fw, rev]
56
58
-o, --output <OUTPUT> Path to output directory
57
59
-t, --threads <THREADS> Number of threads to use [default: 16]
This is resolved from the selected chemistry's permit-list metadata in the registry.
100
102
- Sample barcode list:
101
103
This is resolved from ``--sample-bc-list`` if provided, otherwise from the selected chemistry's registry metadata.
104
+
- Sample barcode orientation:
105
+
By default, ``simpleaf`` forwards the chemistry preset's declared ``sample_bc_ori`` (when present) to ``alevin-fry``. Pass ``--sample-bc-ori {fw,rev}`` to override the preset value at the CLI level. This is useful for cycle-plan variants where the sample BC is read from the opposite strand vs the canonical preset — for example, 10x Flex Configuration B (R1=28 / R2=90) uses ``--sample-bc-ori fw`` whereas the default 10x Flex v2 Configuration A preset declares ``reverse``. The CLI value ``fw`` is forwarded to ``alevin-fry`` as ``forward`` and ``rev`` as ``reverse``; if nothing is set on the CLI and the preset is silent, ``alevin-fry`` defaults to ``forward``.
0 commit comments