RandomUniverseNetworkBasedEnrichmentAlgorithm Class Reference

Calculates enrichment based on network connectivity using various randomization techniques by randomizing the structure of the underlying universal graph. More...

#include <enrichment-algorithm.h>

Inheritance diagram for RandomUniverseNetworkBasedEnrichmentAlgorithm:

List of all members.

Classes
struct	randomUniverseEnrichmentResult
	This structure stores various enrichment results calculated during functional enrichment. Any p-values that are computed will be stored in this structure along with their associated function.
Public Member Functions
	RandomUniverseNetworkBasedEnrichmentAlgorithm (const MyGraph &clusterGraph, const MyGraph &universeGraph, MyAnnotations &annotations, const GeneOntology &go, string category, unsigned int numRandomGraphs, unsigned int numRandomizationIterations)
	Default constructor.
virtual	~RandomUniverseNetworkBasedEnrichmentAlgorithm ()
	Default destructor.
virtual void	computeEnrichedFunctions (const set< string > &functionsToProcess)
	Computes the enrichment of all the functions.
void	computeEnrichmentForFunction (const string funcType, const string funcId)
	Computes whether one function is enriched.
void	printEnrichmentResult (ostream &ostr, randomUniverseEnrichmentResult result)
	Prints functional enrichment information for a single function.
virtual void	printEnrichmentResults (ostream &ostr)
	prints the enrichment results for each function.

---

Detailed Description

Calculates enrichment based on network connectivity using various randomization techniques by randomizing the structure of the underlying universal graph.

---

Constructor & Destructor Documentation

RandomUniverseNetworkBasedEnrichmentAlgorithm::RandomUniverseNetworkBasedEnrichmentAlgorithm	(	const MyGraph &	clusterGraph,
		const MyGraph &	universeGraph,
		MyAnnotations &	annotations,
		const GeneOntology &	go,
		string	category,
		unsigned int	numRandomGraphs,
		unsigned int	numRandomizationIterations
	)

Default constructor.

Parameters:

[in]	clusterGraph	an instance of MyGraph storing the "cluster" we want to compute functional enrichment for.
[in]	universeGraph	an instance of MyGraph storing the universe of genes.
[in]	annotations	The annotations for the genes.
[in]	go	an instance of the Gene Ontology DAG

Warning:

clusterGraph should be a subgraph of universeGraph, but the class does not check this condition.

Parameters:

[in]	numRandomGraphs	an integer specifying how many random graphs to produce.
[in]	numRandomizationIterations	an integer specifying how many iterations to run the randomization algorithm to produce a single random graph.

---

Member Function Documentation

void RandomUniverseNetworkBasedEnrichmentAlgorithm::computeEnrichmentForFunction	(	const string	funcType,
		const string	funcId
	)		[virtual]

Computes whether one function is enriched.

Parameters:

[in]	type	a string specifying the type of the function.
[in]	functionId	a string specifying function.

Implements FunctionalEnrichmentAlgorithm.

void RandomUniverseNetworkBasedEnrichmentAlgorithm::printEnrichmentResult	(	ostream &	ostr,
		randomUniverseEnrichmentResult	result
	)

Prints functional enrichment information for a single function.

Parameters:

[in]	ostream,an	output stream to which the results will be written.
[in]	enrichmentResult	an instance of the enrichment result structure to print.

void RandomUniverseNetworkBasedEnrichmentAlgorithm::printEnrichmentResults

(

ostream &

ostr

)

[virtual]

prints the enrichment results for each function.

Parameters:

[in]

ostr,an

output stream to which the results will be written. Use cout for printing to a terminal.

Implements FunctionalEnrichmentAlgorithm.

---

The documentation for this class was generated from the following files:

• /home/poirel/src/c++/biorithm/libfun/enrichment-algorithm.h
• /home/poirel/src/c++/biorithm/libfun/enrichment-algorithm.C