Skip to content

Commit b5beac5

Browse files
docs: document WarpDemuX adapter sets, naming convention, and upstream repo
Add WarpDemuX repo link, model naming convention breakdown, expanded kit table, and info admonition about standard vs tRNA-specific models. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent f5adfa5 commit b5beac5

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

docs/user-guide/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,8 @@ opts:
218218

219219
## WarpDemuX Demultiplexing
220220

221+
See [WarpDemuX](https://github.com/KleistLab/WarpDemuX) for more information.
222+
221223
For multiplexed samples, enable barcode demultiplexing:
222224

223225
```yaml

docs/workflow/demultiplexing.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,27 @@ Create a config file with demux enabled:
7676

7777
## Barcode Kits
7878

79-
### Available Kits
79+
[WarpDemuX](https://github.com/KleistLab/WarpDemuX) provides adapter-based barcode demultiplexing for Oxford Nanopore direct RNA sequencing. This pipeline uses tRNA-specific WarpDemuX models trained for the Nano-tRNAseq protocol.
80+
81+
### Naming Convention
82+
83+
Model names follow the format: `WDX[n_barcodes][alt_set]_tRNA_rna004_v1_0`
8084

81-
| Kit | Barcodes | Notes |
82-
|-----|----------|-------|
83-
| `WDX4_tRNA_rna004_v1_0` | barcode03, barcode04, barcode05, barcode07 | **Recommended** |
84-
| `WDX4b_tRNA_rna004_v1_0` | barcode04, barcode05, barcode07, barcode11 | Alternative |
85+
- **`WDX`** — WarpDemuX prefix
86+
- **`[n_barcodes]`** — number of barcodes in the set (e.g., `4`)
87+
- **`[alt_set]`** — optional letter for alternative adapter sets (e.g., `b`)
88+
- **`_tRNA_`** — indicates tRNA-specific model
89+
- **`rna004_v1_0`** — ONT RNA004 chemistry version
90+
91+
### Available Kits
8592

86-
### Performance
93+
| Kit | # Barcodes | Barcode IDs | Notes |
94+
|-----|------------|-------------|-------|
95+
| `WDX4_tRNA_rna004_v1_0` | 4 | barcode03, barcode04, barcode05, barcode07 | **Recommended**, +3-7% recovery |
96+
| `WDX4b_tRNA_rna004_v1_0` | 4 | barcode04, barcode05, barcode07, barcode11 | Alternative adapter set |
8797

88-
`WDX4_tRNA_rna004_v1_0` provides +3-7% improved read recovery compared to `WDX4b_tRNA_rna004_v1_0`.
98+
!!! info "Standard RNA004 Models"
99+
WarpDemuX also offers standard RNA004 models (WDX4, WDX6, WDX10) for mRNA and other direct RNA applications. See the [WarpDemuX README](https://github.com/KleistLab/WarpDemuX) for details. This pipeline requires the **`_tRNA_`** variants.
89100

90101
!!! warning "Protocol Compatibility"
91102
WarpDemuX-tRNA models are developed specifically for the **Nano-tRNAseq protocol**. They do **NOT** work with data using the Thomas splint adapter.

0 commit comments

Comments
 (0)