kaori::SingleBarcodePairedEnd< max_size > Class Template Reference

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

#include <SingleBarcodePairedEnd.hpp>

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

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

Detailed Description

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

Handler for paired-end single barcodes.

In this design, the barcoding element is created from a template with a single variable region drawn from a pool of barcode sequences. The construct containing the barcoding element is then subjected to paired-end sequencing, where either end could contain the barcoding element. This handler will search both reads for the barcoding element and count the frequency of each barcode.

Template Parameters

max_size

Maximum length of the template sequence.

Constructor & Destructor Documentation

SingleBarcodePairedEnd()

template<size_t max_size>

kaori::SingleBarcodePairedEnd< max_size >::SingleBarcodePairedEnd ( const char *  template_seq, size_t  template_length, const BarcodePool &  barcode_pool, const Options &  options  )

inline

Parameters

[in]	template_seq	Template sequence of the barcoding element. This should contain exactly one variable region.
	template_length	Length of the template. This should be less than or equal to max_size.
	barcode_pool	Known barcode sequences for the variable region.
	options	Optional parameters.

Member Function Documentation

get_counts()

template<size_t max_size>

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

inline

Returns

Vector containing the frequency of each barcode. This has length equal to the number of valid barcodes (i.e., the length of barcode_pool in the constructor).

get_total()

template<size_t max_size>

int kaori::SingleBarcodePairedEnd< 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/SingleBarcodePairedEnd.hpp