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
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.
Copy file name to clipboardExpand all lines: docs/source/flex-quant-command.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ The relevant options (which you can obtain by running ``simpleaf multiplex-quant
55
55
--expected-ori <EXPECTED_ORI>
56
56
Expected read orientation: fw, rc, or both [default: both]
57
57
--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]
59
59
-o, --output <OUTPUT> Path to output directory
60
60
-t, --threads <THREADS> Number of threads to use [default: 16]
61
61
-h, --help Print help
@@ -103,7 +103,7 @@ Fields stored in a chemistry preset:
- ``expected_ori`` — orientation of the biological read relative to the reference (``fw`` / ``rc`` / ``both``). CLI override: ``--expected-ori``.
105
105
- ``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.
107
107
- ``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.
108
108
- ``version`` and ``meta`` — internal preset versioning and free-form metadata. Not exposed at the CLI; they do not affect pipeline behavior.
109
109
@@ -141,7 +141,7 @@ Example: run a chemistry that is not yet in the registry (e.g. a 10x Flex v2 Con
This is resolved from ``--sample-bc-list`` if provided, otherwise from the selected chemistry's registry metadata.
169
169
- 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``.
171
171
172
172
USA-mode requirements
173
173
---------------------
@@ -255,7 +255,7 @@ Override the sample barcode orientation for a cycle-plan variant (e.g. 10x Flex
0 commit comments