Nemo  2.4.2
Simulate forward-in-time genetic evolution in a spatially explicit, individual-based stochastic simulator
TTNOhtaStats Class Reference

TTNOhtaStats. More...

#include <ttneutralgenes.h>

+ Inheritance diagram for TTNOhtaStats:
+ Collaboration diagram for TTNOhtaStats:

Public Member Functions

 TTNOhtaStats (TProtoNeutralGenes *T)
 
virtual ~TTNOhtaStats ()
 
virtual void FHwrite ()
 
virtual void FHread (string &filename)
 
- Public Member Functions inherited from TraitFileHandler< TProtoNeutralGenes >
 TraitFileHandler (TProtoNeutralGenes *trait_proto, const char *ext)
 
virtual ~TraitFileHandler ()
 
virtual void FHread (string &filename)=0
 
virtual void set (bool rpl_per, bool gen_per, int rpl_occ, int gen_occ, int rank, string path, TProtoNeutralGenes *trait_proto)
 
virtual void set_multi (bool rpl_per, bool gen_per, int rpl_occ, TMatrix *Occ, string path, TProtoNeutralGenes *trait_proto)
 
- Public Member Functions inherited from FileHandler
 FileHandler (const char *ext)
 
virtual ~FileHandler ()
 
virtual void init ()
 Called by notifier during simulation setup, performs file checking. More...
 
virtual vector< string > ifExist ()
 Checks if any file associated with the current file name already exists on disk. More...
 
virtual void set (bool rpl_per, bool gen_per, int rpl_occ, int gen_occ, int rank, string path)
 Sets the hanlder parameters. More...
 
virtual void set_multi (bool rpl_per, bool gen_per, int rpl_occ, TMatrix *Occ, string path)
 
virtual void update ()
 Updates the inner replicate and generation counters and calls FHwrite if needed by the the periodicity of the file. More...
 
Metapopget_pop_ptr ()
 Returns the pointer to the current metapop through the FileServices interface. More...
 
void set_pop_ptr (Metapop *pop_ptr)
 
FileServicesget_service ()
 Returns pointer to the FileServices. More...
 
void set_service (FileServices *srv)
 
std::string & get_path ()
 
void set_path ()
 
std::string & get_extension ()
 
void set_extension (const char *ext)
 
std::string & get_filename ()
 Builds and returns the current file name depending on the periodicity of the file. More...
 
bool get_isInputHandler ()
 
void set_isInputHandler (bool val)
 
bool get_isReplicatePeriodic ()
 
void set_isReplicatePeriodic (bool val)
 
unsigned int get_ReplicateOccurrence ()
 
void set_ReplicateOccurrence (unsigned int val)
 
bool get_isGenerationPeriodic ()
 
void set_isGenerationPeriodic (bool val)
 
unsigned int get_GenerationOccurrence ()
 
void set_GenerationOccurrence (unsigned int val)
 
unsigned int get_ExecRank ()
 unused yet... More...
 
void set_ExecRank (int val)
 
TMatrixget_OccMatrix ()
 
void set_OccMatrix (TMatrix *occ)
 
bool get_isMasterExec ()
 
void set_isMasterExec (bool is)
 
- Public Member Functions inherited from Handler
virtual ~Handler ()
 

Private Attributes

TMatrix _pairwiseCombs
 

Additional Inherited Members

- Protected Attributes inherited from TraitFileHandler< TProtoNeutralGenes >
TProtoNeutralGenes_FHLinkedTrait
 
int _FHLinkedTraitIndex
 
- Protected Attributes inherited from FileHandler
Metapop_pop
 Pointer to the current metapop, set during initialization within the init function. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ TTNOhtaStats()

TTNOhtaStats::TTNOhtaStats ( TProtoNeutralGenes T)
inline

◆ ~TTNOhtaStats()

virtual TTNOhtaStats::~TTNOhtaStats ( )
inlinevirtual
306 {}

Member Function Documentation

◆ FHread()

virtual void TTNOhtaStats::FHread ( string &  filename)
inlinevirtual

Implements FileHandler.

308 {}

◆ FHwrite()

void TTNOhtaStats::FHwrite ( )
virtual

Implements TraitFileHandler< TProtoNeutralGenes >.

1786 {
1787  Metapop* pop = get_pop_ptr();
1788  int patchNbr = pop->getPatchNbr();
1789  unsigned int nb_allele = _FHLinkedTrait->get_allele_num();
1790  unsigned int nb_locus = _FHLinkedTrait->get_locus_num();
1791 
1792  // Output Ohta stats :
1793  // Only if pop alive
1794  // Only for diallelic mutation models
1795  // Only for multi-population scenarios
1796  if ((!pop->isAlive()) || (nb_allele > 2) || (patchNbr < 2)) {
1797  error("TTNOhtaStats::neutral trait and population are not compatible with Ohta stats (min. 2 patches, di-allelic loci), file will not be written.\n");
1798  return;
1799  }
1800 
1801  _pairwiseCombs.copy(nChooseKVec(nb_locus, 2));
1802 
1803  unsigned int num_comb = _pairwiseCombs.nrows();
1804 
1805  ostringstream REC;
1806  Individual* ind;
1807  TTrait* trait;
1808  Patch* current_patch;
1809 
1810  vector<double> Dis(num_comb, 0.0),
1811  Dst(num_comb, 0.0),
1812  Disp(num_comb, 0.0),
1813  Dstp(num_comb, 0.0);
1814 
1815  vector< vector<double> > rSquare = vector< vector<double> > (patchNbr, vector<double>(num_comb, 0.0));
1816 
1817  vector<bool> NA(num_comb, false);
1818 
1819  int total_size = 0;
1820  int extant_patches = 0;
1821 
1822  vector<int> patchSizes(patchNbr, 0);
1823 
1824  // pre-record patch sizes and number of extant patches
1825  for(int patch = 0; patch < patchNbr; patch++) {
1826 
1827  current_patch = pop->getPatch(patch);
1828 
1829  patchSizes[patch] = 2 * (current_patch->size(FEM, ADLTx) + current_patch->size(MAL, ADLTx));
1830 
1831  if(patchSizes[patch]) ++extant_patches; // count patches with individuals
1832 
1833  total_size += patchSizes[patch];
1834  }
1835 
1836 #ifdef _DEBUG_
1837  message("TTNOhtaStats::FHwrite:: computing association stats of %i combinations\n", num_comb);
1838  fflush(stdout);
1839 #endif
1840 
1841 
1842  unsigned int a1, a2;
1843  unsigned int twoLocHapMap[2][2] = {{0,1},{2,3}}; // genot: AB, Ab, aB, ab; A = 0, a = 1, B = 2, b = 3
1844  unsigned int reverseHapMap[4][2] = {{0,2},{0,3},{1,2},{1,3}}; // AB -> {0,2} ...
1845 
1846  vector< double > meanGenoFreq(4,0.0); // allele counter at the two loci,0 = [0], 1 = [1], 0 = [2], 1 = [3]
1847  vector< double > meanHapFreq(4,0.0); // genotype counter
1848 
1849  vector< vector< double > > genoFreq = vector< vector< double > > (patchNbr, vector< double >(4,0.0));
1850  vector< vector< double > > hapFreq = vector< vector< double > > (patchNbr, vector< double >(4,0.0));
1851 
1852  // cycling through all pairwise locus combinations
1853  for (size_t pcomb = 0; pcomb < num_comb; pcomb++) {
1854 
1855  size_t loc1 = _pairwiseCombs.get(pcomb,0),
1856  loc2 = _pairwiseCombs.get(pcomb,1);
1857 
1858  unsigned int refLoc1, refLoc2;
1859 
1860  current_patch = pop->getPatch(0);
1861 
1862  ind = current_patch->get(FEM, ADLTx, 0);
1863 
1864  trait = ind->getTrait(_FHLinkedTraitIndex);
1865 
1866  // reference alleles from the first female adult of the first patch
1867  refLoc1 = trait->get_allele(loc1, 0);
1868  refLoc2 = trait->get_allele(loc2, 0);
1869 
1870  meanGenoFreq.assign(4, 0.0);
1871  meanHapFreq.assign(4,0.0);
1872 
1873  for(int patch = 0; patch < patchNbr; patch++) {
1874 
1875  current_patch = pop->getPatch(patch);
1876 
1877  genoFreq[patch].assign(4,0.0);
1878  hapFreq[patch].assign(4,0.0);
1879 
1880  if(patchSizes[patch] == 0) continue;
1881 
1882  // All adults in a patch
1883  for(unsigned int s =0; s < 2; ++s) { // two sexes
1884 
1885  for(unsigned int j = 0, size = current_patch->size(sex_t(s), ADLTx); j < size; j++) {
1886 
1887  ind = current_patch->get(sex_t(s), ADLTx, j);
1888 
1889  trait = ind->getTrait(_FHLinkedTraitIndex);
1890 
1891  // Homologous copy 1
1892  // locus 1
1893  if (trait->get_allele(loc1, 0) == refLoc1) {
1894  ++genoFreq[patch][0];
1895  a1 = 0;
1896  }
1897  else {
1898  ++genoFreq[patch][1];
1899  a1 = 1;
1900  }
1901 
1902  // locus 2
1903  if (trait->get_allele(loc2, 0) == refLoc2) {
1904  ++genoFreq[patch][2];
1905  a2 = 0;
1906  }
1907  else {
1908  ++genoFreq[patch][3];
1909  a2 = 1;
1910  }
1911 
1912  ++hapFreq[patch][twoLocHapMap[a1][a2]];
1913 
1914  // Homologous copy 2
1915  // locus 1
1916  if (trait->get_allele(loc1, 1) == refLoc1) {
1917  ++genoFreq[patch][0];
1918  a1 = 0;
1919  }
1920  else {
1921  ++genoFreq[patch][1];
1922  a1 = 1;
1923  }
1924 
1925  // locus 2
1926  if (trait->get_allele(loc2, 1) == refLoc2) {
1927  ++genoFreq[patch][2];
1928  a2 = 0;
1929  }
1930  else {
1931  ++genoFreq[patch][3];
1932  a2 = 1;
1933  }
1934 
1935  ++hapFreq[patch][twoLocHapMap[a1][a2]];
1936  } // All individuals
1937  } // two sexes
1938 
1939  for (size_t geno = 0; geno < 4; geno++) {
1940  genoFreq[patch][geno] /= patchSizes[patch];
1941  meanGenoFreq[geno] += genoFreq[patch][geno];
1942  }
1943 
1944  for (size_t hap = 0; hap < 4; hap++) {
1945  hapFreq[patch][hap] /= patchSizes[patch];
1946  meanHapFreq[hap] += hapFreq[patch][hap];
1947  }
1948  } // All patches
1949 
1950  for (size_t geno = 0; geno < 4; geno++)
1951  meanGenoFreq[geno] /= extant_patches;
1952 
1953  for (size_t hap = 0; hap < 4; hap++)
1954  meanHapFreq[hap] /= extant_patches;
1955 
1956  // eliminate pairs with fixed alleles
1957  if ( !(meanGenoFreq[0]*meanGenoFreq[1]) && !(meanGenoFreq[2] * meanGenoFreq[3]))
1958  NA[pcomb] = true;
1959 
1960  if (!NA[pcomb]) {
1961 
1962  for(int patch = 0; patch < patchNbr; patch++) {
1963 
1964  if(!patchSizes[patch]) continue;
1965 
1966  for (size_t hap = 0; hap < 4; hap++) {
1967  // Ohta (1982), Eq. 10
1968  Dis[pcomb] += pow(hapFreq[patch][hap] -
1969  (genoFreq[patch][reverseHapMap[hap][0]] * genoFreq[patch][reverseHapMap[hap][1]]), 2);
1970 
1971  // Ohta (1982), Eq. 11
1972  Dst[pcomb] += pow((genoFreq[patch][reverseHapMap[hap][0]] * genoFreq[patch][reverseHapMap[hap][1]]) -
1973  (meanGenoFreq[reverseHapMap[hap][0]] * meanGenoFreq[reverseHapMap[hap][1]]), 2);
1974 
1975  // Ohta (1982), Eq. 12
1976  Disp[pcomb] += pow(hapFreq[patch][hap] - meanHapFreq[hap], 2);
1977 
1978  // Ohta (1982), Eq. 13
1979  Dstp[pcomb] += pow(meanHapFreq[hap] -
1980  (meanGenoFreq[reverseHapMap[hap][0]] * meanGenoFreq[reverseHapMap[hap][1]]), 2);
1981  }
1982 
1983  double denom = genoFreq[patch][0] * genoFreq[patch][1] * genoFreq[patch][2] * genoFreq[patch][3];
1984 
1985  if (denom == 0.0)
1986  rSquare[patch][pcomb] = 0;
1987  else
1988  rSquare[patch][pcomb] = pow(hapFreq[patch][0] - genoFreq[patch][0]*genoFreq[patch][2], 2)
1989  / denom;
1990  }
1991 
1992  // Ohta (1982), Eq. 10-13
1993  Dis[pcomb] /= extant_patches;
1994  Dst[pcomb] /= extant_patches;
1995  Disp[pcomb] /= extant_patches;
1996  Dstp[pcomb] /= extant_patches;
1997 
1998  }
1999 
2000 // cout << "\nLocus " << loc1+1 << " and locus " << loc2+1 << endl;
2001 // cout << "\"A allele\" : " << refLoc1 << "\n\"B allele\" : " << refLoc2 << endl;
2002 // for(int patch = 0; patch < patchNbr; patch++) {
2003 // cout << "Patch " << patch+1 << endl;
2004 // for (size_t geno = 0; geno < Gtypes.size(); geno++)
2005 // cout << geno << " : " << genoFreq[patch][geno] << endl;
2006 // for (size_t hap = 0; hap < Htypes.size(); hap++)
2007 // cout << hap << " : " << hapFreq[patch][hap] << endl;
2008 // for (size_t hap = 0; hap < Htypes.size(); hap++)
2009 // cout << "Exp_" << reverseHapMap[hap][0] << reverseHapMap[hap][1] << " : " << (genoFreq[patch][reverseHapMap[hap][0]] * genoFreq[patch][reverseHapMap[hap][1]]) << endl;
2010 // }
2011 // cout << "*****************" << endl;
2012 // for (size_t geno = 0; geno < Gtypes.size(); geno++)
2013 // cout << geno << " : " << meanGenoFreq[geno] << endl;
2014 // for (size_t hap = 0; hap < Htypes.size(); hap++)
2015 // cout << hap << " : " << meanHapFreq[hap] << endl;
2016 // for (size_t hap = 0; hap < Htypes.size(); hap++)
2017 // cout << "Exp_" << reverseHapMap[hap][0] << reverseHapMap[hap][1] << " : " << (meanGenoFreq[reverseHapMap[hap][0]] * meanGenoFreq[reverseHapMap[hap][1]]) << endl;
2018 // cout << "*****************" << endl;
2019 
2020  } // All pairwise locus combinations
2021 
2022  string filename = get_filename();
2023  ofstream FILE;
2024 
2025  //open file for writing
2026  FILE.open(filename.c_str(), ios::out);
2027  std::ios_base::sync_with_stdio(false); // better for writing performances
2028 
2029  if(!FILE) fatal("Trait neutral could not open output file: \"%s\"\n",filename.c_str());
2030 
2031 #ifdef _DEBUG_
2032  message("TTNOhtaStats::FHwrite (%s)\n",filename.c_str());
2033  fflush(stdout);
2034 #endif
2035 
2036  FILE << "loc1\tloc2\tDst\tDis\tDstp\tDisp";
2037  for(int patch = 0; patch < patchNbr; patch++)
2038  FILE << "\tr_" << patch+1;
2039  FILE << endl;
2040 
2041  for (size_t pcomb = 0; pcomb < num_comb; pcomb++) {
2042  if (!NA[pcomb]) {
2043  FILE << _pairwiseCombs.get(pcomb,0)+1 << "\t" << _pairwiseCombs.get(pcomb,1)+1 << "\t"
2044  << Dst[pcomb] << "\t" << Dis[pcomb] << "\t" << Dstp[pcomb] << "\t" << Disp[pcomb];
2045  for(int patch = 0; patch < patchNbr; patch++)
2046  FILE << "\t" << rSquare[patch][pcomb];
2047  FILE << endl;
2048  }
2049  }
2050 
2051  FILE.close();
2052  std::ios_base::sync_with_stdio(true); // reset
2053 }
std::string & get_filename()
Builds and returns the current file name depending on the periodicity of the file.
Definition: filehandler.cc:149
Metapop * get_pop_ptr()
Returns the pointer to the current metapop through the FileServices interface.
Definition: filehandler.h:133
This class contains traits along with other individual information (sex, pedigree,...
Definition: individual.h:47
TTrait * getTrait(IDX T)
Trait accessor.
Definition: individual.h:275
Top class of the metapopulation structure, contains the patches.
Definition: metapop.h:78
unsigned int getPatchNbr()
Definition: metapop.h:274
bool isAlive()
Checks if the population still contains at least one individual in any sex or age class.
Definition: metapop.h:307
Patch * getPatch(unsigned int i)
Patch accessor, return the ith+1 patch in the metapop.
Definition: metapop.h:255
Second class in the metapopulation design structure, between the Metapop and Individual classes.
Definition: metapop.h:430
unsigned int size(age_t AGE)
Returns the size of the container of the appropriate age class(es) for both sexes.
Definition: metapop.h:496
Individual * get(sex_t SEX, age_idx AGE, unsigned int at)
Returns a pointer to the individual sitting at the index passed.
Definition: metapop.h:532
void assign(sex_t SEX, age_idx AGE, size_t n)
Assigns a new container of given size for the sex and age class passed, sets all values to NULL.
Definition: metapop.h:559
void copy(const TMatrix &mat)
Copy a matrix.
Definition: tmatrix.h:76
double get(unsigned int i, unsigned int j) const
Accessor to element at row i and column j.
Definition: tmatrix.h:191
unsigned int nrows() const
Definition: tmatrix.h:211
unsigned int get_locus_num()
Definition: ttneutralgenes.h:198
unsigned int get_allele_num()
Definition: ttneutralgenes.h:199
TMatrix _pairwiseCombs
Definition: ttneutralgenes.h:301
Interface for all trait types, declares all basic trait operations.
Definition: ttrait.h:44
virtual unsigned int get_allele(int loc, int all) const =0
Called to read the allele identity at a locus.
int _FHLinkedTraitIndex
Definition: filehandler.h:222
TProtoNeutralGenes * _FHLinkedTrait
Definition: filehandler.h:221
void fatal(const char *str,...)
Definition: output.cc:98
int error(const char *str,...)
Definition: output.cc:77
void message(const char *message,...)
Definition: output.cc:38
sex_t
Sex types, males are always 0 and females 1!!
Definition: types.h:34
@ FEM
Definition: types.h:35
@ MAL
Definition: types.h:35
@ ADLTx
Definition: types.h:40
TMatrix nChooseKVec(int n, int k)
Definition: utils.cc:196

References TraitFileHandler< TProtoNeutralGenes >::_FHLinkedTrait, TraitFileHandler< TProtoNeutralGenes >::_FHLinkedTraitIndex, _pairwiseCombs, ADLTx, Patch::assign(), TMatrix::copy(), error(), fatal(), FEM, Patch::get(), TMatrix::get(), TTrait::get_allele(), TProtoNeutralGenes::get_allele_num(), FileHandler::get_filename(), TProtoNeutralGenes::get_locus_num(), FileHandler::get_pop_ptr(), Metapop::getPatch(), Metapop::getPatchNbr(), Individual::getTrait(), Metapop::isAlive(), MAL, message(), nChooseKVec(), TMatrix::nrows(), and Patch::size().

Member Data Documentation

◆ _pairwiseCombs

TMatrix TTNOhtaStats::_pairwiseCombs
private

Referenced by FHwrite().


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

Generated for Nemo v2.4.2 by  doxygen 1.9.1

Catalogued on GSR