Skip to content

Commit e9450f6

Browse files
committed
docs(multiplex-quant): use forward/reverse for --sample-bc-ori everywhere
Per design discussion on PR #199: keep the CLI vocabulary consistent with the chemistry preset JSON and with alevin-fry's --sample-bc-ori. Update the -h snippet, "Chemistry preset structure" bullet, "Sample barcode orientation" prose, and both example commands.
1 parent 20effa0 commit e9450f6

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/source/flex-quant-command.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The relevant options (which you can obtain by running ``simpleaf multiplex-quant
5555
--expected-ori <EXPECTED_ORI>
5656
Expected read orientation: fw, rc, or both [default: both]
5757
--sample-bc-ori <SAMPLE_BC_ORI>
58-
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]
58+
Sample barcode orientation override: ``forward`` (whitelist matches read as-is) or ``reverse`` (reverse-complement the whitelist before lookup). Overrides the chemistry preset's ``sample_bc_ori`` when set; otherwise the preset value (if any) is used. Vocabulary matches the chemistry preset JSON and ``alevin-fry --sample-bc-ori`` [possible values: forward, reverse]
5959
-o, --output <OUTPUT> Path to output directory
6060
-t, --threads <THREADS> Number of threads to use [default: 16]
6161
-h, --help Print help
@@ -103,7 +103,7 @@ Fields stored in a chemistry preset:
103103
- ``geometry`` — piscem geometry string describing R1/R2 layout (cell BC, UMI, sample BC, biological-read offsets). CLI override: ``--geometry``.
104104
- ``expected_ori`` — orientation of the biological read relative to the reference (``fw`` / ``rc`` / ``both``). CLI override: ``--expected-ori``.
105105
- ``plist_name`` and ``remote_url`` — cached filename and download URL for the cell barcode whitelist. CLI override: ``--cell-bc-list`` (pass a local path; the URL itself is an internal detail).
106-
- ``sample_bc_list`` *(Flex only)* — a nested record with ``plist_name``, ``remote_url``, and ``sample_bc_ori``. CLI overrides: ``--sample-bc-list`` for the 3-column TSV path, and ``--sample-bc-ori`` (``fw`` / ``rev``) for the orientation.
106+
- ``sample_bc_list`` *(Flex only)* — a nested record with ``plist_name``, ``remote_url``, and ``sample_bc_ori``. CLI overrides: ``--sample-bc-list`` for the 3-column TSV path, and ``--sample-bc-ori`` (``forward`` / ``reverse``) for the orientation.
107107
- ``probe_sets`` *(Flex only)* — an organism-keyed dictionary, e.g. ``{ "human": {...}, "mouse": {...} }``. Each entry stores a probe-CSV download URL plus probe-set metadata. CLI overrides: ``--organism`` selects which entry is consulted, and ``--probe-set`` bypasses the lookup entirely by supplying a local CSV/FASTA.
108108
- ``version`` and ``meta`` — internal preset versioning and free-form metadata. Not exposed at the CLI; they do not affect pipeline behavior.
109109

@@ -141,7 +141,7 @@ Example: run a chemistry that is not yet in the registry (e.g. a 10x Flex v2 Con
141141
$ simpleaf multiplex-quant \
142142
--geometry '1{b[16]u[12]x:}2{r[50]f[CCCATATAAGAAAACCTGAATACGCGGTT]s[10]x:}' \
143143
--expected-ori fw \
144-
--sample-bc-ori fw \
144+
--sample-bc-ori forward \
145145
--cell-bc-list /path/to/cell_bc_whitelist.txt \
146146
--sample-bc-list /path/to/sample_bc_rotation.tsv \
147147
--probe-set /path/to/probe_set.csv \
@@ -167,7 +167,7 @@ Resource resolution
167167
- Sample barcode list:
168168
This is resolved from ``--sample-bc-list`` if provided, otherwise from the selected chemistry's registry metadata.
169169
- Sample barcode orientation:
170-
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``.
170+
By default, ``simpleaf`` forwards the chemistry preset's declared ``sample_bc_ori`` (when present) to ``alevin-fry``. Pass ``--sample-bc-ori {forward,reverse}`` 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 forward`` whereas the default 10x Flex v2 Configuration A preset declares ``reverse``. The CLI value is forwarded verbatim to ``alevin-fry --sample-bc-ori``; if nothing is set on the CLI and the preset is silent, ``alevin-fry`` defaults to ``forward``.
171171

172172
USA-mode requirements
173173
---------------------
@@ -255,7 +255,7 @@ Override the sample barcode orientation for a cycle-plan variant (e.g. 10x Flex
255255
--chemistry 10x-flexv2-gex-3p \
256256
--organism human \
257257
--geometry '1{b[16]u[12]x:}2{r[50]f[CCCATATAAGAAAACCTGAATACGCGGTT]s[10]x:}' \
258-
--sample-bc-ori fw \
258+
--sample-bc-ori forward \
259259
--reads1 sample_R1.fastq.gz \
260260
--reads2 sample_R2.fastq.gz \
261261
--output flex_out

0 commit comments

Comments
 (0)