Sleipnir
Public Member Functions | Data Fields
Sleipnir::STermFound Struct Reference

Encapsulates the hypergeometric functional enrichment of a query against one ontology term. More...

#include <annotation.h>

Public Member Functions

 STermFound (size_t iID, double dP, size_t iHitsTerm, size_t iSizeTerm, size_t iHitsTotal, size_t iSizeTotal)
 Construct a new structure with the given parameter values.

Data Fields

size_t m_iID
 ID of the ontology term for this enrichment.
double m_dP
 Hypergeometric p-value of this enrichment.
size_t m_iHitsTerm
 The number of genes in Q intersect T.
size_t m_iSizeTerm
 The number of genes in T.
size_t m_iHitsTotal
 The number of genes in Q.
size_t m_iSizeTotal
 The total number of genes in the background set (genome).

Detailed Description

Encapsulates the hypergeometric functional enrichment of a query against one ontology term.

Generated by an IOntology::TermFinder call, each STermFound struct represents the hypergeometric enrichment of one ontology term for a set of query genes. Documentation assumes a set of query genes Q and a set of term genes T.

See also:
IOntology

Definition at line 38 of file annotation.h.


Constructor & Destructor Documentation

Sleipnir::STermFound::STermFound ( size_t  iID,
double  dP,
size_t  iHitsTerm,
size_t  iSizeTerm,
size_t  iHitsTotal,
size_t  iSizeTotal 
) [inline]

Construct a new structure with the given parameter values.

Parameters:
iIDID of the ontology term for this enrichment.
dPHypergeometric p-value of this enrichment.
iHitsTermThe number of genes in Q intersect T.
iSizeTermThe number of genes in T.
iHitsTotalThe number of genes in Q.
iSizeTotalThe total number of genes in the background set (genome).

Definition at line 92 of file annotation.h.


The documentation for this struct was generated from the following file: