kaori::DualBarcodesSingleEnd< max_size > Class Template Reference

Handler for single-end dual barcodes. More...

#include <DualBarcodesSingleEnd.hpp>

Classes
struct	Options
	Optional parameters for DualBarcodeSingleEnd. More...

Public Member Functions
	DualBarcodesSingleEnd (const char *template_seq, size_t template_length, const std::vector< BarcodePool > &barcode_pools, const Options &options)
const std::vector< int > &	get_counts () const
int	get_total () const

Detailed Description

template<size_t max_size>
class kaori::DualBarcodesSingleEnd< max_size >

Handler for single-end dual barcodes.

In this design, the barcoding element is created from a template with multiple variable regions. Each region contains a barcode from a different pool of options, where the valid combinations of barcodes across variable regions are known beforehand. This differs from CombinatorialBarcodesSingleEnd where the combinations are assembled randomly. Despite its name, this handler can actually handle any number (>= 2) of variable regions in the combination. It will count the frequency of each barcode combination, along with the total number of reads.

Template Parameters

max_size

Maximum length of the template sequence.

Constructor & Destructor Documentation

DualBarcodesSingleEnd()

template<size_t max_size>

kaori::DualBarcodesSingleEnd< max_size >::DualBarcodesSingleEnd ( const char *  template_seq, size_t  template_length, const std::vector< BarcodePool > &  barcode_pools, const Options &  options  )

inline

Parameters

[in]	template_seq	Template sequence containing any number (usually 2 or more) of variable regions.
	template_length	Length of the template. This should be less than or equal to max_size.
	barcode_pools	Array containing the known barcode sequences for each of the variable regions, in the order of their appearance in the template sequence. Each pool should have the same length, and corresponding values across pools define a specific combination of barcodes.
	options	Optional parameters.

Member Function Documentation

get_counts()

template<size_t max_size>

const std::vector< int > & kaori::DualBarcodesSingleEnd< max_size >::get_counts ( ) const

inline

Returns

Counts for each combination.

get_total()

template<size_t max_size>

int kaori::DualBarcodesSingleEnd< max_size >::get_total ( ) const

inline

Returns

Total number of reads processed by the handler.

---

The documentation for this class was generated from the following file:

• kaori/handlers/DualBarcodesSingleEnd.hpp