A library for working with phylogenetic and population genetic data.
v0.32.0
DiversityPoolSettings Struct Reference

#include <genesis/population/function/diversity_pool_functions.hpp>

Detailed Description

Settings used by different pool-sequencing corrected diversity statistics.

These settings are used by DiversityPoolCalculator, and for example by theta_pi_pool(), theta_watterson_pool(), and tajima_d_pool(), in order to have them in a central place, and avoid ordering confusion of function arguments, that would result from having to provide them individually.

Note in particular the setting tajima_denominator_policy, which controls how we correct the denominator the computation of Tajima's D.

Definition at line 141 of file diversity_pool_functions.hpp.

Public Attributes

size_t max_read_depth = 0
 
size_t min_count = 0
 
size_t min_read_depth = 0
 
TajimaDenominatorPolicy tajima_denominator_policy = TajimaDenominatorPolicy::kUncorrected
 

Member Data Documentation

◆ max_read_depth

size_t max_read_depth = 0

Definition at line 145 of file diversity_pool_functions.hpp.

◆ min_count

size_t min_count = 0

Definition at line 143 of file diversity_pool_functions.hpp.

◆ min_read_depth

size_t min_read_depth = 0

Definition at line 144 of file diversity_pool_functions.hpp.

◆ tajima_denominator_policy

Definition at line 147 of file diversity_pool_functions.hpp.


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