--input | path | — | Samplesheet CSV (sample,fastq_1,fastq_2). Required unless --demo |
--output | path | — | Output directory for results and the reproducibility bundle (required) |
--demo | flag | — | Run the upstream nf-core test profile; forces --preset star and skip_cellbender |
--check | flag | — | Run preflight only and exit (no Nextflow execution) |
--preset | string | standard | Aligner preset |
--aligner | string | — | nf-core/scrnaseq aligner alias for --preset: simpleaf maps to standard; the other values map to same-named presets |
--profile | string | docker | Execution backend or comma-separated nf-core profile list: docker, conda, mamba, singularity, apptainer, podman, shifter, charliecloud, wave, gpu, debug, arm64, emulate_amd64, test, test_full, test_cellrangermulti, test_multiome |
--pipeline-version | string | 4.1.0 | Remote nf-core/scrnaseq tag or commit (used when no local sibling checkout is found) |
--allow-dirty-pipeline | flag | — | Development-only opt-in to run a modified local sibling scrnaseq/ checkout; rejected by default for production reproducibility |
--require-local-pipeline | flag | — | Require a verifiable local sibling scrnaseq/ checkout; fail instead of falling back to the remote pipeline |
--allow-pipeline-version-override | flag | — | Allow a --pipeline-version other than the pinned 4.1.0 contract (warned, recorded in provenance; validations stay 4.1.0) |
--trust-config-params | flag | — | Allow -c/--config files that set params.* (otherwise blocked); detected overrides are recorded in provenance |
-c / --config | path | — | Additional Nextflow config file. May be repeated; files are validated, applied to the live run, copied into the reproducibility bundle, and replayed by commands.sh |
--protocol | string | None | Chemistry/protocol forwarded to the aligner. Required for standard, star, and kallisto; omitted only preserves CellRanger auto-detection for cellranger, cellrangerarc, and cellrangermulti. Explicit auto is invalid for standard, star, and kallisto. smartseq is valid for star and kallisto only. Other protocol strings are mapped when known or passed through by nf-core |
--genome | string | — | iGenomes shortcut (GRCh38, mm10, etc.) — mutually exclusive with --fasta/--gtf and all index flags |
--igenomes-base | string | — | Base URL or local path for iGenomes (default s3://ngi-igenomes/igenomes/). Use for local mirrors or air-gapped clusters. A local base path is existence-checked in preflight when --genome is set (remote s3:///https:// bases are deferred to Nextflow) |
--igenomes-ignore | flag | — | Do not load the iGenomes reference config. Set automatically whenever an explicit genome reference is supplied; only needed manually in unusual setups |
--fasta | path | — | Genome FASTA (.fa, .fna, .fasta, .gz variants; no whitespace in path) |
--gtf | path | — | Gene annotation GTF |
--star-index | path | — | Prebuilt STAR genome index directory |
--simpleaf-index | path | — | Prebuilt simpleaf/alevin-fry index |
--kallisto-index | path | — | Prebuilt kallisto index |
--cellranger-index | path | — | Prebuilt CellRanger or CellRanger ARC reference |
--transcript-fasta | path | — | Transcriptome FASTA for simpleaf |
--txp2gene | path | — | Transcript-to-gene mapping for simpleaf |
--barcode-whitelist | path | — | Custom barcode whitelist (per-aligner format) |
--star-feature | enum | — | STARsolo feature type: Gene, GeneFull, Gene Velocyto |
--star-ignore-sjdbgtf | flag | — | Do not use GTF for SJDB construction (required for Gene Velocyto) |
--seq-center | string | — | Sequencing center name for BAM read group tag |
--simpleaf-umi-resolution | enum | — | UMI resolution strategy for alevin-fry: cr-like, cr-like-em, parsimony, parsimony-em, parsimony-gene, parsimony-gene-em |
--kb-workflow | enum | — | Kallisto workflow: standard, lamanno, nac |
--kb-t1c | path | — | cDNA transcripts-to-capture file for RNA velocity (lamanno/nac). Required only with a prebuilt --kallisto-index; auto-generated from --fasta/--gtf |
--kb-t2c | path | — | Intron transcripts-to-capture file for RNA velocity (lamanno/nac). Required only with a prebuilt --kallisto-index; auto-generated from --fasta/--gtf |
--skip-cellbender | flag | — | Disable the CellBender ambient RNA removal subworkflow |
--skip-emptydrops | flag | — | Deprecated compatibility alias for --skip-cellbender; the wrapper writes skip_cellbender: true and never writes deprecated upstream skip_emptydrops |
--skip-fastqc | flag | — | Skip FastQC quality control |
--skip-multiqc | flag | — | Skip MultiQC report generation |
--skip-cellranger-renaming | flag | — | Skip automatic sample renaming in CellRanger modules |
--skip-cellrangermulti-vdjref | flag | — | Skip mkvdjref in cellrangermulti (when VDJ data is absent or a prebuilt --cellranger-vdj-index is supplied) |
--save-reference | flag | — | Save the built reference index for future reuse |
--save-align-intermeds / --no-save-align-intermeds | flag | — | Forward save_align_intermeds: true/false; when neither is given the upstream nf-core/scrnaseq 4.1.0 default (true) is preserved, so intermediate BAMs are published by default — pass --no-save-align-intermeds on large runs to save disk |
--expected-cells | int | — | Override expected cell count for a single-sample samplesheet; multi-sample runs must set expected_cells per row. The wrapper enforces ≥1 (stricter than the upstream integer schema, which has no minimum) since a non-positive count is meaningless |
--timeout-hours | float | 12 | Wall-clock cap for the Nextflow run, in hours. Use 0 to disable the cap for long HPC/cloud runs whose walltime is enforced by the scheduler. Via the ClawBio runner the runner's own timeout also applies |
--work-dir | string | <output>/upstream/work | Nextflow work directory. Local paths are resolved before execution; object-store URIs such as s3://... or gs://... are passed through for cloud executors |
--allow-conda-cellranger | flag | — | Allow Cell Ranger presets with conda/mamba only when a trusted site config supplies Cell Ranger |
--email | string | — | Email address for pipeline completion notification |
--email-on-fail | string | — | Email address for pipeline failure notification |
--multiqc-title | string | — | Custom title for the MultiQC report |
--multiqc-config | path | — | Custom MultiQC config YAML |
--multiqc-logo | path | — | Custom MultiQC logo image |
--multiqc-methods-description | path | — | Custom MultiQC methods-description YAML |
--publish-dir-mode | enum | — | Forwarded nf-core publish mode: symlink, rellink, link, copy, copyNoFollow, or move |
--trace-report-suffix | string | — | Suffix for Nextflow trace/report/timeline filenames |
--monochrome-logs | flag | — | Disable ANSI colors in nf-core logs |
--resume | flag | — | Nextflow resume (checksum-verified against prior manifest; preset/profile/source/work-dir must match) |
--run-downstream | flag | — | Opt in to scrna_orchestrator handoff after pipeline completion |
--skip-downstream | flag | — | Force-skip the downstream handoff even if --run-downstream is given (handoff is off by default) |
--cellrangerarc-config | path | — | Config JSON for CellRanger ARC index construction |
--cellrangerarc-reference | string | — | Reference genome name used inside the CellRanger ARC config |
--motifs | path | — | Motif file (e.g. JASPAR) for CellRanger ARC |
--cellranger-vdj-index | path | — | Prebuilt CellRanger VDJ reference |
--gex-frna-probe-set | path | — | Probe set CSV for FFPE fixed RNA profiling (cellrangermulti) |
--gex-target-panel | path | — | Target panel CSV for targeted GEX (cellrangermulti) |
--gex-cmo-set | path | — | CMO reference CSV for multiplexed samples (cellrangermulti) |
--gex-barcode-sample-assignment | path | — | Barcode-to-sample assignment override CSV (cellrangermulti). Not an OCM selector — OCM mode is encoded via the ocm_ids column of --cellranger-multi-barcodes |
--fb-reference | path | — | Feature-barcode reference CSV for antibody capture (cellrangermulti) |
--vdj-inner-enrichment-primers | path | — | V(D)J cDNA enrichment primer sequences (cellrangermulti) |
--cellranger-multi-barcodes | path | — | Multiplexed sample samplesheet for CMO/FFPE demultiplexing (cellrangermulti) |