diff plotFingerprint.xml @ 10:314348664620 draft

planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0eeb2e1a184186ba5ac044136e71b943e2af0f09

--- a/plotFingerprint.xml	Tue Oct 25 19:05:49 2016 -0400
+++ b/plotFingerprint.xml	Mon Dec 05 08:06:43 2016 -0500
@@ -19,6 +19,15 @@
                 #if $output.saveRawCounts:
                     --outRawCounts '$outFileRawCounts'
                 #end if
+                #if $output.saveQualityMetrics:
+                    --outQualityMetrics '$outFileQualityMetrics'
+                    #if $output.JSDsample:
+                        #if "'{}'".format($output.JSDsample.display_name) in $labels:
+                            #set JSDidx = $labels.index("'{}'".format($output.JSDsample.display_name))
+                            --JSDsample "./${JSDidx}.bam"
+                        #end if
+                    #end if
+                #end if
             #else
                 --plotFileFormat 'png'
             #end if
@@ -34,10 +43,6 @@
                 $advancedOpt.ignoreDuplicates
                 $advancedOpt.skipZeros
 
-                #if $advancedOpt.minMappingQuality:
-                --minMappingQuality '$advancedOpt.minMappingQuality'
-                #end if
-
                 #if $advancedOpt.plotTitle and str($advancedOpt.plotTitle.value) != "":
                     --plotTitle '$advancedOpt.plotTitle'
                 #end if
@@ -80,6 +85,11 @@
             <when value="yes">
                 <expand macro="input_image_file_format" />
                 <param name="saveRawCounts" type="boolean" label="Save the bin counts" help="(--outRawCounts)"/>
+                <param name="saveQualityMetrics" type="boolean" label="Save quality metrics"
+                   help="The file will have one row per input BAM file and columns containing a variety of QC metrics. For the full description of all metrics and their interpretation, please see our online documentation: http://deeptools.readthedocs.io/en/latest/content/feature/plotFingerprint_QC_metrics.html. (--outQualityMetrics)"/>
+                <param name="JSDsample" type="data" format="bam"
+                   label="Jensen-Shannon distance reference sample"
+                   help="If output metrics should be saved, then use this sample as the reference for computing the Jensen-Shannon distance and CHANCE metrics of all other samples. Normally this is an input sample. If you don't specify this, then these metrics will not be computed. This is only applicable if quality metrics are being saved. (--JSDsample)" />
             </when>
         </conditional>
     </inputs>
@@ -93,6 +103,14 @@
             ))
             </filter>
         </data>
+        <data format="tabular" name="outFileQualityMetrics" label="${tool.name} on ${on_string}: quality metrics">
+            <filter>
+            ((
+                output['showOutputSettings'] == 'yes' and
+                output['saveQualityMetrics'] is True
+            ))
+            </filter>
+        </data>
     </outputs>
     <tests>
         <test>
@@ -106,9 +124,12 @@
             <param name="showAdvancedOpt" value="yes" />
             <param name="showOutputSettings" value="yes" />
             <param name="saveRawCounts" value="True" />
+            <param name="saveQualityMetrics" value="True" />
             <param name="plotTitle" value="Test Fingerprint Plot" />
+            <param name="JSDsample" value="bowtie2 test1.bam" ftype="bam" />
             <output name="outFileName" file="plotFingerprint_result2.png" ftype="png" compare="sim_size" />
             <output name="outFileRawCounts" file="plotFingerprint_result2.tabular" ftype="tabular" />
+            <output name="outFileQualityMetrics" file="plotFingerprint_quality_metrics.tabular" ftype="tabular" />
         </test>
     </tests>
     <help>
@@ -127,7 +148,7 @@
 
 The default output is a diagnostic plot (see below for an example and further down for some background information).
 
-Optionally, you can obtain the table of raw counts that was used to generate the plot.
+Optionally, you can obtain the table of raw values that were used to generate the plot.
 
 .. image:: $PATH_TO_IMAGES/plotFingerprint_output.png
   :width: 600
@@ -149,10 +170,10 @@
 Theoretical Background
 ----------------------
 
-The tool first samples indexed BAM files and counts all reads overlapping a window (bin) of the specified length.
-These counts are then sorted according to their rank (the bin with the highest number of reads has the highest rank)
-and the cumulative sum of read counts are plotted. An ideal input (control) with a uniform distribution of reads alignments
-result in a diagonal line. A very specific and strong ChIP enrichment, on the other hand, would result in a large portion
+The tool first samples indexed BAM files and sums the per-base coverage of reads/fragments overlapping a window (bin) of the specified length.
+These values are then sorted according to their rank (the bin with the highest number of reads has the highest rank)
+and the cumulative sum plotted. An ideal input (control) with a uniform distribution of reads alignments
+and infinite sequencing depth will result in a diagonal line. A very specific and strong ChIP enrichment, on the other hand, would result in a large portion
 of reads accumulating in just a few bins and the resulting plot showing a steep rise toward the right-most edge. Such results are
 most commonly seen with transcription factors.