Egglib 2.1.11
C++ library reference manual
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MicrosatelliteDiversity Class Reference

Analyzes microsatellite data. More...

#include <MicrosatelliteDiversity.hpp>

Public Member Functions

 MicrosatelliteDiversity ()
 Creates an object. More...
 
virtual ~MicrosatelliteDiversity ()
 Destroys an object. More...
 
void load (const DataMatrix &dataMatrix, int missingData=999, bool noMissingData=false)
 Performs the analysis. More...
 
unsigned int numberOfSites () const
 Number of sites (or markers)
 
double He (unsigned int siteIndex) const
 Heterozygosity.
 
unsigned int numberOfAlleles (unsigned int siteIndex) const
 Number of alleles.
 
double sizeVariance (unsigned int siteIndex) const
 Variance of allele size.
 
double thetaAssumingIAM (unsigned int siteIndex) const
 IAM-based estimator of theta.
 
double thetaAssumingSMMfromHe (unsigned int siteIndex) const
 SMM-based estimator of theta, calculated from He.
 
double thetaAssumingSMMfromSizeVariance (unsigned int siteIndex) const
 SMM-based estimator of theta, calculated from VarSize.
 

Protected Member Functions

void init ()
 
void clear ()
 

Protected Attributes

unsigned int v_numberOfSites
 
double * v_He
 
unsigned int * v_numberOfAlleles
 
double * v_sizeVariance
 
double * v_thetaAssumingIAM
 
double * v_thetaAssumingSMMfromHe
 
double * v_thetaAssumingSMMfromSizeVariance
 

Detailed Description

Analyzes microsatellite data.

Use the load() method to analyze data. All sites will be analyzed and accessors allow to access the value of a given statistics for a given site. There is no out-of-bound checking implemented in accessors.

Constructor & Destructor Documentation

Creates an object.

Destroys an object.

Member Function Documentation

void load ( const DataMatrix dataMatrix,
int  missingData = 999,
bool  noMissingData = false 
)

Performs the analysis.

Parameters
dataMatrixthe object to analyze.
missingDatathe integer identifying missing data.
noMissingDataif true, no allele will be excluded (including the one identified by the argument missingData).

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

Hosted by 
Get EggLib at SourceForge.net. Fast, secure and Free Open Source software downloads