diff --git a/docs/DualBarcodesWithDiagnostics_8hpp.html b/docs/DualBarcodesPairedEndWithDiagnostics_8hpp.html similarity index 89% rename from docs/DualBarcodesWithDiagnostics_8hpp.html rename to docs/DualBarcodesPairedEndWithDiagnostics_8hpp.html index 8411228..1cf457f 100644 --- a/docs/DualBarcodesWithDiagnostics_8hpp.html +++ b/docs/DualBarcodesPairedEndWithDiagnostics_8hpp.html @@ -5,7 +5,7 @@ -
Process dual barcodes with extra diagnostics. More...
-Go to the source code of this file.
+Go to the source code of this file.
Classes | |
class | kaori::DualBarcodesWithDiagnostics< max_size > |
Handler for dual barcodes with extra diagnostics. More... | |
class | kaori::DualBarcodesPairedEndWithDiagnostics< max_size > |
Handler for dual barcodes with extra diagnostics. More... | |
diff --git a/docs/DualBarcodesWithDiagnostics_8hpp_source.html b/docs/DualBarcodesPairedEndWithDiagnostics_8hpp_source.html
similarity index 58%
rename from docs/DualBarcodesWithDiagnostics_8hpp_source.html
rename to docs/DualBarcodesPairedEndWithDiagnostics_8hpp_source.html
index 707eede..a23ce89 100644
--- a/docs/DualBarcodesWithDiagnostics_8hpp_source.html
+++ b/docs/DualBarcodesPairedEndWithDiagnostics_8hpp_source.html
@@ -5,7 +5,7 @@
-DualBarcodesWithDiagnostics.hpp DualBarcodesPairedEndWithDiagnostics.hpp
-
+Go to the documentation of this file.
+
-
+
-
+
-
+
-
+
49 dual_handler(template_seq1, template_length1, barcode_pool1, template_seq2, template_length2, barcode_pool2, options),
@@ -106,31 +106,31 @@
-
+
-
-
-
-
+
+
+
+
67 // we allow duplicates in the trie for each individual barcode, as only the pairs are unique in the dual barcode setup.
-
+
-
+
- 85 State(typename DualBarcodes<max_size>::State ds, typename CombinatorialBarcodesPairedEnd<max_size>::State cs) : dual_state(std::move(ds)), combo_state(std::move(cs)) {}
+ 85 State(typename DualBarcodesPairedEnd<max_size>::State ds, typename CombinatorialBarcodesPairedEnd<max_size>::State cs) : dual_state(std::move(ds)), combo_state(std::move(cs)) {}
-
+
@@ -152,54 +152,57 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
+
+
+
Process paired-end combinatorial barcodes. Process dual barcodes. Process dual barcodes. Handler for paired-end combinatorial barcodes. Definition: CombinatorialBarcodesPairedEnd.hpp:29 Handler for dual barcodes with extra diagnostics. Definition: DualBarcodesWithDiagnostics.hpp:26 int get_barcode1_only() const Definition: DualBarcodesWithDiagnostics.hpp:161 const std::vector< int > & get_counts() const Definition: DualBarcodesWithDiagnostics.hpp:139 int get_total() const Definition: DualBarcodesWithDiagnostics.hpp:154 const std::vector< std::array< int, 2 > > & get_combinations() const Definition: DualBarcodesWithDiagnostics.hpp:147 int get_barcode2_only() const Definition: DualBarcodesWithDiagnostics.hpp:168 DualBarcodesWithDiagnostics(const char *template_seq1, size_t template_length1, const BarcodePool &barcode_pool1, const char *template_seq2, size_t template_length2, const BarcodePool &barcode_pool2, const typename DualBarcodes< max_size >::Options &options) Definition: DualBarcodesWithDiagnostics.hpp:44 Handler for dual barcodes with extra diagnostics. Definition: DualBarcodesPairedEndWithDiagnostics.hpp:26 const std::vector< std::array< int, 2 > > & get_combinations() const Definition: DualBarcodesPairedEndWithDiagnostics.hpp:147 const std::vector< int > & get_counts() const Definition: DualBarcodesPairedEndWithDiagnostics.hpp:139 DualBarcodesPairedEndWithDiagnostics(const char *template_seq1, size_t template_length1, const BarcodePool &barcode_pool1, const char *template_seq2, size_t template_length2, const BarcodePool &barcode_pool2, const typename DualBarcodesPairedEnd< max_size >::Options &options) Definition: DualBarcodesPairedEndWithDiagnostics.hpp:44 int get_barcode2_only() const Definition: DualBarcodesPairedEndWithDiagnostics.hpp:168 void sort() Definition: DualBarcodesPairedEndWithDiagnostics.hpp:130 int get_barcode1_only() const Definition: DualBarcodesPairedEndWithDiagnostics.hpp:161 int get_total() const Definition: DualBarcodesPairedEndWithDiagnostics.hpp:154 Optional parameters for SingleBarcodeSingleEnd. Definition: DualBarcodes.hpp:32 Optional parameters for DualBarcodesPairedEnd. Definition: DualBarcodesPairedEnd.hpp:32 int max_mismatches1 Definition: DualBarcodesPairedEnd.hpp:42 int max_mismatches2 Definition: DualBarcodesPairedEnd.hpp:53 SearchStrand strand2 Definition: DualBarcodesPairedEnd.hpp:59 bool use_first Definition: DualBarcodesPairedEnd.hpp:37 SearchStrand strand1 Definition: DualBarcodesPairedEnd.hpp:48 diff --git a/docs/DualBarcodes_8hpp.html b/docs/DualBarcodesPairedEnd_8hpp.html similarity index 86% rename from docs/DualBarcodes_8hpp.html rename to docs/DualBarcodesPairedEnd_8hpp.html index 01ddfcd..585b474 100644 --- a/docs/DualBarcodes_8hpp.html +++ b/docs/DualBarcodesPairedEnd_8hpp.html @@ -5,7 +5,7 @@ - DualBarcodes.hpp File Reference DualBarcodesPairedEnd.hpp File Reference |
Classes | |
class | kaori::DualBarcodes< max_size > |
Handler for dual barcodes. More... | |
class | kaori::DualBarcodesPairedEnd< max_size > |
Handler for dual barcodes. More... | |
struct | kaori::DualBarcodes< max_size >::Options |
Optional parameters for SingleBarcodeSingleEnd . More... | |
struct | kaori::DualBarcodesPairedEnd< max_size >::Options |
Optional parameters for DualBarcodesPairedEnd . More... | |
diff --git a/docs/DualBarcodes_8hpp_source.html b/docs/DualBarcodesPairedEnd_8hpp_source.html
similarity index 84%
rename from docs/DualBarcodes_8hpp_source.html
rename to docs/DualBarcodesPairedEnd_8hpp_source.html
index b7d95b6..b0dabac 100644
--- a/docs/DualBarcodes_8hpp_source.html
+++ b/docs/DualBarcodesPairedEnd_8hpp_source.html
@@ -5,7 +5,7 @@
-DualBarcodes.hpp DualBarcodesPairedEnd.hpp
+Go to the documentation of this file.
@@ -88,29 +88,29 @@
-
+
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -189,7 +189,7 @@
-
+
@@ -392,22 +392,25 @@
-
+
-
+
-
-
-
-
-
DualBarcodes(const char *template_seq1, size_t template_length1, const BarcodePool &barcode_pool1, const char *template_seq2, size_t template_length2, const BarcodePool &barcode_pool2, const Options &options) Definition: DualBarcodes.hpp:92 const std::vector< int > & get_counts() const Definition: DualBarcodes.hpp:396 const std::vector< int > & get_counts() const Definition: DualBarcodesPairedEnd.hpp:396 DualBarcodesPairedEnd(const char *template_seq1, size_t template_length1, const BarcodePool &barcode_pool1, const char *template_seq2, size_t template_length2, const BarcodePool &barcode_pool2, const Options &options) Definition: DualBarcodesPairedEnd.hpp:92 int get_total() const Definition: DualBarcodesPairedEnd.hpp:403 Search for known barcode sequences with segmented mismatches. Definition: BarcodeSearch.hpp:290 void search(const std::string &search_seq, State &state) const Definition: BarcodeSearch.hpp:461 Optional parameters for SingleBarcodeSingleEnd. Definition: DualBarcodes.hpp:32 Optional parameters for DualBarcodesPairedEnd. Definition: DualBarcodesPairedEnd.hpp:32 int max_mismatches1 Definition: DualBarcodesPairedEnd.hpp:42 int max_mismatches2 Definition: DualBarcodesPairedEnd.hpp:53 SearchStrand strand2 Definition: DualBarcodesPairedEnd.hpp:59 DuplicateAction duplicates Definition: DualBarcodesPairedEnd.hpp:64 bool use_first Definition: DualBarcodesPairedEnd.hpp:37 SearchStrand strand1 Definition: DualBarcodesPairedEnd.hpp:48 Optional parameters for a SegmentedBarcodeSearch. Definition: BarcodeSearch.hpp:295 std::array< int, num_segments > max_mismatches Definition: BarcodeSearch.hpp:309 CCombinatorialBarcodesPairedEnd | Handler for paired-end combinatorial barcodes | ▼CCombinatorialBarcodesSingleEnd | Handler for single-end combinatorial barcodes | COptions | Optional parameters for | CombinatorialBarcodeSingleEnd ▼CDualBarcodes | Handler for dual barcodes | COptions | Optional parameters for | SingleBarcodeSingleEnd CDualBarcodesWithDiagnostics | Handler for dual barcodes with extra diagnostics | ▼CDualBarcodesPairedEnd | Handler for dual barcodes | COptions | Optional parameters for | DualBarcodesPairedEnd CDualBarcodesPairedEndWithDiagnostics | Handler for dual barcodes with extra diagnostics | CFastqReader | Stream reads from a FASTQ file | ▼CMismatchTrie | Base class for the mismatch search | CAddStatus | Status of the barcode sequence addition |
-
kaori::DualBarcodes< max_size > Member List kaori::DualBarcodesPairedEnd< max_size > Member List
-
This is the complete list of members for kaori::DualBarcodes< max_size >, including all inherited members. +This is the complete list of members for kaori::DualBarcodesPairedEnd< max_size >, including all inherited members.
diff --git a/docs/classkaori_1_1DualBarcodes.html b/docs/classkaori_1_1DualBarcodesPairedEnd.html similarity index 77% rename from docs/classkaori_1_1DualBarcodes.html rename to docs/classkaori_1_1DualBarcodesPairedEnd.html index 235afca..089e76e 100644 --- a/docs/classkaori_1_1DualBarcodes.html +++ b/docs/classkaori_1_1DualBarcodesPairedEnd.html @@ -5,7 +5,7 @@ -
-
+ kaori::DualBarcodes< max_size > Class Template Reference kaori::DualBarcodesPairedEnd< max_size > Class Template Reference |
Classes | |
struct | Options |
Optional parameters for SingleBarcodeSingleEnd . More... | |
struct | Options |
Optional parameters for DualBarcodesPairedEnd . More... | |
Public Member Functions | |
DualBarcodes (const char *template_seq1, size_t template_length1, const BarcodePool &barcode_pool1, const char *template_seq2, size_t template_length2, const BarcodePool &barcode_pool2, const Options &options) | |
const std::vector< int > & | get_counts () const |
int | get_total () const |
DualBarcodesPairedEnd (const char *template_seq1, size_t template_length1, const BarcodePool &barcode_pool1, const char *template_seq2, size_t template_length2, const BarcodePool &barcode_pool2, const Options &options) | |
const std::vector< int > & | get_counts () const |
int | get_total () const |
Handler for dual barcodes.
+class kaori::DualBarcodesPairedEnd< max_size >Handler for dual barcodes.
In this design, each read contains a barcoding element created from a template with a single variable region. For one read, the barcode is drawn from one pool of options, while the other read contains a barcode from another pool. However, unlike CombinatorialBarcodesPairedEnd
, the combinations are not random but are specifically assembled, typically corresponding to specific pairs of genes. This handler will capture the frequencies of each barcode combination.