NeighborSeq::NeighborStats Struct Reference

Statistics of how many neighbors were found per reference peptide. More...

#include <OpenMS/ANALYSIS/ID/NeighborSeq.h>

Collaboration diagram for NeighborSeq::NeighborStats:

Public Member Functions
int	total () const
	Sum of all four categories (i.e. the number of relevant peptides registered at construction time).
int	percentOfTotal_ (int count) const
	percentage (0..100) of count relative to total; returns 0 when total is 0 (avoids integer division by zero)
std::string	unfindable () const
	unfindable_peptides formatted as "X (Y%)"; returns "X (0%)" when total is 0.
std::string	noNB () const
	findable_no_neighbors formatted as "X (Y%)"; returns "X (0%)" when total is 0.
std::string	oneNB () const
	findable_one_neighbor formatted as "X (Y%)"; returns "X (0%)" when total is 0.
std::string	multiNB () const
	findable_multiple_neighbors formatted as "X (Y%)"; returns "X (0%)" when total is 0.

Public Attributes
NeigborStats_members
Mutually exclusive categories of how many neighbors were found per reference peptide
int	unfindable_peptides = 0
	how many ref-peptides contain an 'X' (unknown amino acid) and thus cannot be searched for neighbors
int	findable_no_neighbors = 0
	how many peptides had no neighbors?
int	findable_one_neighbor = 0
	how many peptides had exactly one neighbor?
int	findable_multiple_neighbors = 0
	how many peptides had multiple neighbors?

Detailed Description

Statistics of how many neighbors were found per reference peptide.

Member Function Documentation

multiNB()

std::string multiNB ( ) const

inline

findable_multiple_neighbors formatted as "X (Y%)"; returns "X (0%)" when total is 0.

noNB()

std::string noNB ( ) const

inline

findable_no_neighbors formatted as "X (Y%)"; returns "X (0%)" when total is 0.

oneNB()

std::string oneNB ( ) const

inline

findable_one_neighbor formatted as "X (Y%)"; returns "X (0%)" when total is 0.

percentOfTotal_()

int percentOfTotal_ ( int  count ) const

inline

percentage (0..100) of count relative to total; returns 0 when total is 0 (avoids integer division by zero)

total()

int total ( ) const

inline

Sum of all four categories (i.e. the number of relevant peptides registered at construction time).

unfindable()

std::string unfindable ( ) const

inline

unfindable_peptides formatted as "X (Y%)"; returns "X (0%)" when total is 0.

Member Data Documentation

findable_multiple_neighbors

int findable_multiple_neighbors = 0

how many peptides had multiple neighbors?

findable_no_neighbors

int findable_no_neighbors = 0

how many peptides had no neighbors?

findable_one_neighbor

int findable_one_neighbor = 0

how many peptides had exactly one neighbor?

unfindable_peptides

int unfindable_peptides = 0

how many ref-peptides contain an 'X' (unknown amino acid) and thus cannot be searched for neighbors