diff mothur/tools/mothur/chimera.pintail.xml @ 2:e990ac8a0f58

Migrated tool version 1.19.0 from old tool shed archive to new tool shed repository

--- a/mothur/tools/mothur/chimera.pintail.xml	Tue Jun 07 17:35:35 2011 -0400
+++ b/mothur/tools/mothur/chimera.pintail.xml	Tue Jun 07 17:39:06 2011 -0400
@@ -1,4 +1,4 @@
-<tool id="mothur_chimera_pintail" name="Chimera.pintail" version="1.16.0">
+<tool id="mothur_chimera_pintail" name="Chimera.pintail" version="1.19.0">
  <description>Find putative chimeras using pintail</description>
  <command interpreter="python">
   mothur_wrapper.py 
@@ -9,7 +9,7 @@
   #set results = $results + ["'^\S+\.pintail\.accnos$:'" + $out_accnos.__str__]
   --outputdir='$logfile.extra_files_path'
   --fasta=$fasta
-  --template=$alignment.template
+  --reference=$alignment.template
   $filter
   #if $mask.source == 'default':
    --mask=default
@@ -38,12 +38,12 @@
  <inputs>
   <param name="fasta" type="data" format="fasta" label="fasta - Candiate Sequences"/>
   <conditional name="alignment">
-   <param name="source" type="select" label="Select Template from" help="">
+   <param name="source" type="select" label="Select Reference Template from" help="">
     <option value="hist">History</option>
     <option value="ref">Cached Reference</option>
    </param>
    <when value="ref">
-    <param name="template" type="select" label="template - Select an alignment database " help="">
+    <param name="template" type="select" label="reference - Select an alignment database " help="">
      <options from_file="mothur_aligndb.loc">
       <column name="name" index="0" />
       <column name="value" index="1" />
@@ -51,7 +51,7 @@
     </param>
    </when>
    <when value="hist">
-    <param name="template" type="data" format="fasta" label="template - Template to align with" help=""/>
+    <param name="template" type="data" format="fasta" label="reference - Reference to align with" help=""/>
    </when>
   </conditional>
   <param name="filter" type="boolean" falsevalue="" truevalue="--filter=true" checked="false" label="filter - Apply a 50% soft vertical filter"/>
@@ -137,8 +137,26 @@
 
 **Command Documenation**
 
-The chimera.pintail_ command identifies putative chimeras using the pintail approach.
+The chimera.pintail_ command identifies putative chimeras using the pintail approach.  It looks at the variation between the expected differences and the observed differences in the query sequence over several windows.
+
+This method was written using the algorithms described in the paper_ "At Least 1 in 20 16S rRNA Sequence Records Currently Held in the Public Repositories is Estimated To Contain Substantial Anomalies" by Kevin E. Ashelford 1, Nadia A. Chuzhanova 3, John C. Fry 1, Antonia J. Jones 2 and Andrew J. Weightman 1.
+
+
+From www.bioinformatics-toolkit.org_
+
+The Pintail algorithm is a technique for determining whether a 16S rDNA sequence is anomalous.  It is based on the idea that the extent of local base differences between two aligned 16S rDNA sequences should be roughly the same along the length of the alignment (having allowed for the underlying pattern of hypervariable and conserved regions known to exist within the 16S rRNA gene).  In other words, evolutionary distance between two reliable sequences should be constant along the length of the gene.  
 
+In contrast, if an error-free sequence is compared with an anomalous sequence, evolutionary distance along the alignment is unlikely to be constant, especially if the anomaly in question is a chimera and formed from phylogenetically different parental sequences.  
+
+The Pintail algorithm is designed to detect and quantify such local variations and in doing so generates the Deviation from Expectation (DE) statistic.  The higher the DE value, the greater the likelihood that the query is anomalous.
+
+The algorithm works as follows
+
+The sequence to be checked (the query) is first globally aligned with a phylogenetically similar sequence known to be error-free (the subject).  At regular intervals along the resulting alignment, the local evolutionary distance between query and subject is estimated by recording percentage base mismatches within a sampling window of fixed length.  The resulting array of percentages (observed percentage differences) reflects variations in evolutionary distance between the query and subject along the length of the 16S rRNA gene.  Subtracting observed percentage differences from an equivalent array of expected percentage differences (predicted values for error-free sequences), we obtain a set of deviations, the standard deviation of which (Deviation from Expectation, DE) summarises the variation between observed and expected datasets.  The greater the DE value, the greater the disparity there is between observed and expected percentage differences, and the more likely it is that the query sequence is anomalous.  
+
+
+.. _paper: http://www.ncbi.nlm.nih.gov/pubmed/16332745
+.. _www.bioinformatics-toolkit.org: http://www.bioinformatics-toolkit.org/Help/Topics/pintailAlgorithm.html
 .. _chimera.pintail: http://www.mothur.org/wiki/Chimera.pintail