Error Metrics

Functions

float error_rate () const
 
float phix_adapter_rate () const
 
const float_vector & phix_adapter_rates () const
 
float phix_adapter_rate_at (const size_t n) const INTEROP_THROW_SPEC((model
 
size_t phix_adapter_count () const
 
uint_t mismatch_cluster_count (const size_t n) const INTEROP_THROW_SPEC((model
 
uint_t mismatch_count () const
 
const uint_array_t & mismatch_cluster_counts () const
 

Detailed Description

Per tile per cycle PhiX sequence error

See full class description

Function Documentation

float error_rate ( ) const
inline

Calculated error rate, as determined by a spiked in PhiX control sample.

Note
Supported by all versions
Returns
error rate
uint_t mismatch_cluster_count ( const size_t  n) const
inline

Number of clusters at given number of mismatches

0: no mismatches 1: 1 mismatch etc.

Note
Suppored by version 3, really unsupported on most platforms, some older MiSeq and HiSeq support
Parameters
nindex of read
Returns
total number of errors
const uint_array_t& mismatch_cluster_counts ( ) const
inline

Get an array of mismatch cluster counts

0: no mismatches 1: 1 mismatch etc.

Note
Suppored by version 3, really unsupported on most platforms, some older MiSeq and HiSeq support
Returns
vector of mismatch cluster counts
uint_t mismatch_count ( ) const
inline

Size of mismatch array

Note
Suppored by version 3, really unsupported on most platforms, some older MiSeq and HiSeq support
Returns
total number of errors
size_t phix_adapter_count ( ) const
inline
float phix_adapter_rate ( ) const
inline

Calculated adapter trim rate of PhiX clusters

Note
Supported by v5
Returns
adapter trim rate
float phix_adapter_rate_at ( const size_t  n) const
inline
const float_vector& phix_adapter_rates ( ) const
inline