Skip to content

Commit 7c2fe31

Browse files
authored
doc: update description of consenus tags for duplex (#983)
1 parent a82cfe0 commit 7c2fe31

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/main/scala/com/fulcrumgenomics/umi/ConsensusTags.scala

+5-3
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ package com.fulcrumgenomics.umi
2828
* Object that encapsulates the various consensus related tags that are added to consensus reads
2929
* at both the per-read and per-base level.
3030
*
31-
* Currently only contains tags for single-strand consensus reads, but with a view to using the following
32-
* names for consistency if/when we add duplex calling:
31+
* Contains tags for both single-strand and duplex consensus reads. The first letter in the tag is `c` if
32+
* it relates to the final consensus read, `a` if it relates to the top-strand of a duplex consensus read,
33+
* and `b` if it relates to the bottom-strand of a duplex consensus read. The second letter in the tag is
34+
* lower case if it is per-base, upper case if it is per-read.
35+
*
3336
* Value AB BA Final
3437
* --------------------- -- -- -----
3538
* per-read-depth aD bD cD
@@ -39,7 +42,6 @@ package com.fulcrumgenomics.umi
3942
* per-base-error-count ae be ce
4043
* per-base-bases ac bc bases
4144
* per-base-quals aq bq quals
42-
* The second letter in the tag is lower case if it is per-base, upper case if it is per-read.
4345
*/
4446
object ConsensusTags {
4547
/** The default field in which to look for UMI sequences and qualities. */

0 commit comments

Comments
 (0)