Skip to content

Commit 23a5b8b

Browse files
committed
docs(multiplex-quant): document --sample-bc-ori CLI override
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
1 parent 60b839b commit 23a5b8b

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

docs/source/flex-quant-command.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ The relevant options (which you can obtain by running ``simpleaf multiplex-quant
5353
Path to cell barcode whitelist (one barcode per line, overrides chemistry default)
5454
--expected-ori <EXPECTED_ORI>
5555
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]
5658
-o, --output <OUTPUT> Path to output directory
5759
-t, --threads <THREADS> Number of threads to use [default: 16]
5860
-r, --resolution <RESOLUTION> UMI resolution mode [default: cr-like] [possible values: cr-like, cr-like-em, parsimony, parsimony-em, parsimony-gene, parsimony-gene-em]
@@ -99,6 +101,8 @@ Resource resolution
99101
This is resolved from the selected chemistry's permit-list metadata in the registry.
100102
- Sample barcode list:
101103
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``.
102106

103107
USA-mode requirements
104108
---------------------
@@ -178,6 +182,19 @@ Request USA-mode probe quantification:
178182
--reads2 sample_R2.fastq.gz \
179183
--output flex_out
180184
185+
Override the sample barcode orientation for a cycle-plan variant (e.g. 10x Flex v2 Configuration B, R1=28 / R2=90):
186+
187+
.. code-block:: console
188+
189+
$ simpleaf multiplex-quant \
190+
--chemistry 10x-flexv2-gex-3p \
191+
--organism human \
192+
--geometry '1{b[16]u[12]x:}2{r[50]f[CCCATATAAGAAAACCTGAATACGCGGTT]s[10]x:}' \
193+
--sample-bc-ori fw \
194+
--reads1 sample_R1.fastq.gz \
195+
--reads2 sample_R2.fastq.gz \
196+
--output flex_out
197+
181198
Output
182199
------
183200

0 commit comments

Comments
 (0)