diff add_fst_column.xml @ 18:f04f40a36cc8

Latest changes from Belinda and Cathy. Webb's updates to the Fst tools.

--- a/add_fst_column.xml	Fri Sep 28 11:57:18 2012 -0400
+++ b/add_fst_column.xml	Tue Oct 23 12:41:52 2012 -0400
@@ -1,4 +1,4 @@
-<tool id="gd_add_fst_column" name="Per-SNP FSTs" version="1.0.0">
+<tool id="gd_add_fst_column" name="Per-SNP FSTs" version="1.1.0">
   <description>: Compute a fixation index score for each SNP</description>
 
   <command interpreter="python">
@@ -34,7 +34,8 @@
 
     <param name="biased" type="select" label="FST estimator">
       <option value="0" selected="true">Wright's original definition</option>
-      <option value="1">Weir's unbiased estimator</option>
+      <option value="1">The Weir-Cockerham estimator</option>
+      <option value="2">The Reich-Patterson estimator</option>
     </param>
 
   </inputs>
@@ -62,30 +63,33 @@
 
 **What it does**
 
-The user specifies a SNP table and two "populations" of individuals,
-both previously defined using the Specify Individuals tool.
-No individual can be in both populations.  Other choices are as follows.
+The user specifies a SNP table and two "populations" of individuals, both previously defined using the Galaxy tool to specify individuals from a SNP table. No individual can be in both populations. Other choices are as follows.
 
-Data source.  The allele frequencies of a SNP in the two populations can be
-estimated either by the total number of reads of each allele, or by adding
-the frequencies inferred from genotypes of individuals in the populations.
+Data source. The allele frequencies of a SNP in the two populations can be estimated either by the total number of reads of each allele, or by adding the frequencies inferred from genotypes of individuals in the populations.
+
+After specifying the data source, the user sets lower bounds on amount of data required at a SNP. For estimating the Fst using read counts, the bound is the minimum count of reads of the two alleles in a population. For estimations based on genotype, the bound is the minimum reported genotype quality per individual.
 
-After specifying the data source, the user sets lower bounds on amount
-of data required at a SNP.  For estimating the Fst using read counts,
-the bound is the minimum count of reads of the two alleles in a population.
-For estimations based on genotype, the bound is the minimum reported genotype
-quality per individual.
+The user specifies whether the SNPs that violate the lower bound should be ignored or the Fst set to -1.
 
-The user specifies whether the SNPs that violate the lower bound should be
-ignored or the Fst set to -1.
+The user specifies whether SNPs where both populations appear to be fixed for the same allele should be retained or discarded.
 
-The user specifies whether SNPs where both populations appear to be fixed
-for the same allele should be retained or discarded.
-
-Finally, the user chooses which definition of Fst to use:  Wright's original
-definition or Weir's unbiased estimator.
+Finally, the user chooses which definition of Fst to use: Wright's original definition, the Weir-Cockerham unbiased estimator, or the Reich-Patterson estimator.
 
 A column is appended to the SNP table giving the Fst for each retained SNP.
 
+References:
+
+Sewall Wright (1951) The genetical structure of populations. Ann Eugen 15:323-354.
+
+B. S. Weir and C. Clark Cockerham (1984) Estimating F-statistics for the analysis of population structure. Evolution 38:1358-1370.
+
+Weir, B.S. 1996. Population substructure. Genetic data analysis II, pp. 161-173. Sinauer Associates, Sundand, MA.
+
+David Reich, Kumarasamy Thangaraj, Nick Patterson, Alkes L. Price, and Lalji Singh (2009) Reconstructing Indian population history. Nature 461:489-494, especially Supplement 2.  
+
+Their effectiveness for computing FSTs when there are many SNPs but few individuals is discussed in the followoing paper.
+
+Eva-Maria Willing, Christine Dreyer, Cock van Oosterhout (2012) Estimates of genetic differentiation measured by FST do not necessarily require large sample sizes when using many SNP markers. PLoS One 7:e42649.
+
   </help>
 </tool>