Read summary

Modules

 Read/Lane summary
 
 Stat summary
 
 Read/Lane summary
 

Functions

const lane_summary & operator[] (const size_t n) const INTEROP_THROW_SPEC((model
 
const_reference at (const size_type n) const INTEROP_THROW_SPEC((model
 
size_t size () const
 
size_t lane_count () const
 
const_iterator begin () const
 
const_iterator end () const
 
const run::read_info & read () const
 
const metric_summary & summary () const
 

Detailed Description

Summary of key metrics in each read

See full class description

Function Documentation

const_reference at ( const size_type  n) const
inline

Get constant reference to lane_summary at given index

Deprecated:
Will be removed in next feature version (use operator[] instead for C++ Code)
Parameters
nindex
Returns
constant reference to lane_summary
const_iterator begin ( ) const
inline

Get constant random access iterator to start of summaries by lane

Returns
constant random access iterator
const_iterator end ( ) const
inline

Get constant random access iterator to end of summaries by lane

Returns
constant random access iterator
size_t lane_count ( ) const
inline

Get number of lanes

Returns
number of lanes
const lane_summary& operator[] ( const size_t  n) const
inline

Get constant reference to lane_summary at given index

Parameters
nindex
Returns
constant reference to lane_summary
const run::read_info& read ( ) const
inline

Get read information

Returns
read information
size_t size ( ) const
inline

Get number of summaries by lane

Returns
number of summaries by lane
const metric_summary& summary ( ) const
inline

Get summary metrics

Returns
summary metrics