Emphasize that we are computing pi_hat for a sinlge site

jdoughertyii · Jan 20, 2012 · c971410 · c971410
1 parent c8753d1
commit c971410
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/vcf.py b/vcf.py
@@ -349,6 +349,10 @@ def num_unknown(self):
     def nucl_diversity(self):
         """
         Calculate pi_hat (estimation of nucleotide diversity) for the site.
+        This metric can be summed across multiple sites to compute regional
+        nucleotide diversity estimates.  For example, pi_hat for all variants
+        in a given gene.
+        
         Derived from: 
         \"Population Genetics: A Concise Guide, 2nd ed., p.45\"
           John Gillespie.