Skip to content

Commit 9743296

Browse files
added documentation for the summary parameters
1 parent ec041ae commit 9743296

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

src/utils/guessprotocol.cpp

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,18 @@ struct nucleotide_model {
103103
};
104104

105105
struct guessprotocol_summary {
106+
// protocol is the guessed protocol (wgbs, pbat, rpbat, or inconclusive)
107+
// based on the content of the reads.
106108
string protocol;
109+
// layout indicates whether the reads are paired or single-ended.
107110
string layout;
111+
// n_reads_wgbs is the average number of reads (for single-ended reads) or
112+
// read pairs (for paired reads) where read1 is T-rich.
108113
double n_reads_wgbs{};
114+
// n_reads is the number of evaluated reads or read pairs.
109115
uint64_t n_reads{};
116+
// wgbs_fraction is the probability that a read (for single-ended reads) or
117+
// the read1 of a read pair (for paired reads) is T-rich.
110118
double wgbs_fraction{};
111119

112120
void evaluate() {

0 commit comments

Comments
 (0)