Skip to content

Commit

Permalink
corrected javadoc for InbreedingCoeff (#5768)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbenjamin authored Mar 7, 2019
1 parent 5648263 commit 342569a
Showing 1 changed file with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@
* higher the chance that some samples are related. If samples are known to be related, a pedigree file can be provided so
* that the calculation is only performed on founders and offspring are excluded.</p>
*
* <h3>Statistical notes</h3>
* <p>The calculation is a continuous generalization of the Hardy-Weinberg test for disequilibrium that works well with limited coverage per sample. The output is a Phred-scaled p-value derived from running the HW test for disequilibrium with PL values. See the <a href="http://www.broadinstitute.org/gatk/guide/article?id=4732">method document on statistical tests</a> for a more detailed explanation of this statistical test.</p>
* <h3>Details</h3>
* <p>The output is the inbreeding coefficient 'F' (fixation) statistic, which for large sample sizes converges to the probability
* that an individual's two alleles are identical by descent, provided that cosanguinuity is the only source of deviation from Hardy-Weinberg equilibrium.
* If this assumption is not true F may be negative and the excess heterozygosity often indicates an artifactual variant.
* It is calculated as F = 1 - (# of het genotypes)/(# of het genotypes expected under Hardy-Weinberg equilibrium). The number of het genotypes expeced under Hardy-Weinberg equilibrium
* is 2*(# of samples)*(ref allele frequency)*(alt allele frequency), where allele frequencies are calculated from the samples' genotypes.</p>
*
* <h3>Caveats</h3>
* <ul>
Expand Down

0 comments on commit 342569a

Please sign in to comment.