kaori::RandomBarcodeSingleEnd< max_size_ > Class Template Reference

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

#include <RandomBarcodeSingleEnd.hpp>

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

Public Member Functions
	RandomBarcodeSingleEnd (const char *template_seq, SeqLength template_length, const Options &options)
const std::unordered_map< std::string, Count > &	get_counts () const
Count	get_total () const

Detailed Description

template<SeqLength max_size_>
class kaori::RandomBarcodeSingleEnd< max_size_ >

Handler for single-end random barcodes.

In this design, the vector sequence is created from a template with a single variable region containing a random barcode sequence. The construct containing the vector sequence is then subjected to single-end sequencing. This handler will search the read for the vector sequence and count the frequency of each random barcode. Random barcodes containing N's are allowed and will be counted separately.

Template Parameters

max_size_

Maximum length of the template sequences on both reads.

Constructor & Destructor Documentation

RandomBarcodeSingleEnd()

template<SeqLength max_size_>

kaori::RandomBarcodeSingleEnd< max_size_ >::RandomBarcodeSingleEnd ( const char * template_seq, SeqLength template_length, const Options & options )

inline

Parameters

[in]	template_seq	Pointer to an array containing the template sequence. This should contain exactly one variable region.
	template_length	Length of the array pointed to by template_seq. This should be less than or equal to max_size_.
	options	Optional parameters.

Member Function Documentation

get_counts()

template<SeqLength max_size_>

const std::unordered_map< std::string, Count > & kaori::RandomBarcodeSingleEnd< max_size_ >::get_counts ( ) const

inline

Returns

Unordered map containing the frequency of each random barcode.

get_total()

template<SeqLength max_size_>

Count kaori::RandomBarcodeSingleEnd< 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/RandomBarcodeSingleEnd.hpp