Skip to content

Commit 21a5bf7

Browse files
committed
upd demux params
1 parent 30d96fc commit 21a5bf7

1 file changed

Lines changed: 19 additions & 14 deletions

File tree

docs/parameters.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,18 @@ For **pre-demultiplexed** data (prepared using external tools):
4343

4444
### Demultiplexing
4545

46-
| Parameter | Description | Default Value |
47-
| -------------------- | ----------------------------------------------------------------------------------------------------------------- | ---------------- |
48-
| `--demultiplexed` | Whether input is multiplexed (`false`, single FASTQ file) or pre-demultiplexed (`true`, multiple FASTQ files) ^1^ | `false` |
49-
| `--lima_minscore` | Barcode score for demultiplexing ^2^ | 93 |
50-
| `--lima_barcodetype` | Barcoding scheme type (`single`, `dual`, `dual_symmetric`, `dual_asymmetric`) ^3^ | `dual_symmetric` |
51-
| `--lima_W` | Window size for barcode lookup | 70 |
52-
| `--lima_minlen` | Minimum sequence length after clipping barcodes | 40 |
46+
| Parameter | Description | Default Value |
47+
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- | ---------------- |
48+
| `--demultiplexed` | Whether input is multiplexed (`false`, single FASTQ file) or pre-demultiplexed (`true`, multiple FASTQ files) ^1^ | `false` |
49+
| `--lima_barcodetype` | Barcoding scheme type (`single`, `dual`, `dual_symmetric`, `dual_asymmetric`) ^2^ | `dual_symmetric` |
50+
| `--lima_minscore` | Barcode score for demultiplexing ^3^ | 93 |
51+
| `--lima_W` | Window size for barcode lookup | 70 |
52+
| `--lima_minlen` | Minimum sequence length after clipping barcodes | 40 |
53+
| `--lima_minendscore` | Score threshold for asymmetric barcoding schemes with different barcodes in a pair | 50 |
54+
| `--lima_minrefspan` | Minimum read span relative to the barcode length | 0.75 |
55+
| `--lima_minscoringregions`| Number of required barcodes for dual barcodes (2 = requires both barcodes) | 2 |
56+
| `--lima_windowsize` | Window size in base pairs | 70 |
57+
| `--lima_remove_unknown` | Remove unknown barcode combinations in dual-barcoding modes | `false` |
5358

5459
^1^:
5560
By default, NextITS assumes you're providing multiplexed data,
@@ -59,6 +64,13 @@ For **pre-demultiplexed** data (prepared using external tools):
5964
use the `--demultiplexed true` option.
6065

6166
^2^:
67+
Barcodes, which can also be referred to as adaptors, tags, indices, molecular identifiers (MIDs), come in various library designs.
68+
At present, NextITS supports 4 barcoding schemes: dual-barcoding (symmetric, assymetric, or mixture of combinatorial tags) and single-barcoding.
69+
For the dual-barcoding scheme, the amplicon should have the barcode on both ends of the amplicon.
70+
An asymmetric design, where each side of the amplicon has a *different barcode pair*, is also supported.
71+
For a comprehensive understanding of barcode designs, please visit [https://lima.how/barcode-design.html](https://lima.how/barcode-design.html).
72+
73+
^3^:
6274
For every barcode, [LIMA](https://lima.how/) evaluates a score corresponding to its region.
6375
This score signifies the alignment accuracy between the chosen barcode and sequencing read,
6476
and it's determined using the Smith-Waterman algorithm.
@@ -67,13 +79,6 @@ For **pre-demultiplexed** data (prepared using external tools):
6779
If you're working with shorter barcodes, such as 10 base pairs, consider reducing the minimum score for optimal results.
6880
For a more comprehensive information, check out [https://lima.how/faq/barcode-score.html](https://lima.how/faq/barcode-score.html).
6981

70-
^3^:
71-
Barcodes, which can also be referred to as adaptors, tags, indices, molecular identifiers (MIDs), come in various library designs.
72-
At present, NextITS supports 4 barcoding schemes: dual-barcoding (symmetric, assymetric, or mixture of combinatorial tags) and single-barcoding.
73-
For the dual-barcoding scheme, the amplicon should have the barcode on both ends of the amplicon.
74-
An asymmetric design, where each side of the amplicon has a *different barcode pair*, is also supported.
75-
For a comprehensive understanding of barcode designs, please visit [https://lima.how/barcode-design.html](https://lima.how/barcode-design.html).
76-
7782

7883
### Quality filtering
7984

0 commit comments

Comments
 (0)