diff samtools_calmd.xml @ 3:609810451a80 draft

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:54:20 -0400
parents 787d6c86c6ea
children ed0f72810fd5
line wrap: on
line diff
--- a/samtools_calmd.xml	Mon Sep 29 12:16:47 2014 -0400
+++ b/samtools_calmd.xml	Tue Oct 13 12:54:20 2015 -0400
@@ -1,9 +1,11 @@
-<tool id="samtools_calmd" name="Recalculate" version="1.0.1">
-    <description>MD/NM tags and '=' bases</description>
-    <requirements>
-        <requirement type="package" version="1.1">samtools</requirement>
-    </requirements>
-    <version_command>samtools --version | head -n 1 | awk '{ print $2 }'</version_command>
+<tool id="samtools_calmd" name="CalMD" version="2.0">
+  <description>recalculate MD/NM tags</description>
+  <macros>
+    <import>macros.xml</import>
+  </macros>
+  <expand macro="requirements"></expand>
+  <expand macro="stdio"></expand>
+  <expand macro="version_command"></expand>
     <command><![CDATA[
         #if str( $reference_source.reference_source_selector ) == "history":
             #set ref_fa = 'ref.fa'
@@ -17,15 +19,12 @@
         #end if
         -b "$input_bam" "$ref_fa" > "$calmd_output" ]]>
     </command>
-    <stdio>
-        <exit_code range="1:" level="fatal" description="Error" />
-    </stdio>
     <inputs>
         <param format="bam" name="input_bam" type="data" label="BAM file to recalculate" />
         <conditional name="reference_source">
-            <param name="reference_source_selector" type="select" label="Choose the source for the reference FASTA">
-                <option value="cached">Locally cached</option>
-                <option value="history">History</option>
+            <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
+                <option value="cached">Use a built-in genome</option>
+                <option value="history">Use a genome from the history</option>
             </param>
             <when value="cached">
                 <param name="ref_fasta" type="select" label="Using reference genome">
@@ -46,10 +45,10 @@
             </param>
             <when value="default" />
             <when value="advanced">
-                <param name="change_identical" type="boolean" truevalue="-e" falsevalue="" checked="False" label="Change identical bases to '='" />
-                <param name="modify_quality" type="boolean" truevalue="-A" falsevalue="" checked="False" label="Modify the quality string" />
-                <param name="compute_cap" type="boolean" truevalue="-r" falsevalue="" checked="False" label="Compute BQ or cap baseQ by BAQ" />
-                <param name="extended_baq" type="boolean" truevalue="-E" falsevalue="" checked="False" label="Extended BAQ for better sensitivity" />
+                <param name="change_identical" type="boolean" truevalue="-e" falsevalue="" checked="False" label="Change identical bases to '='" help="-e"/>
+                <param name="modify_quality" type="boolean" truevalue="-A" falsevalue="" checked="False" label="Modify the quality string" help="-A"/>
+                <param name="compute_cap" type="boolean" truevalue="-r" falsevalue="" checked="False" label="Compute BQ or cap baseQ by BAQ" help="-r"/>
+                <param name="extended_baq" type="boolean" truevalue="-E" falsevalue="" checked="False" label="Extended BAQ for better sensitivity" help="-E"/>
             </when>
         </conditional>
     </inputs>
@@ -59,52 +58,42 @@
     <tests>
         <test>
             <param name="option_sets" value="default" /> 
-            <param name="input_bam" value="phiX.bam" dbkey="phiX" />
-            <param name="reference_source|reference_source_selector" value="history" />
-            <param name="ref_fasta" value="phiX.fasta" dbkey="phiX" />
-            <output name="calmd_output" file="samtools_calmd_out_1.bam" ftype="bam" />
-        </test>
-        <!-- Using the test-data-repo's phiX.fa should produce the same output. -->
-        <test>
-            <param name="option_sets" value="default" /> 
-            <param name="input_bam" value="phiX.bam" dbkey="phiX" />
-            <param name="reference_source|reference_source_selector" value="cached" />
-            <param name="ref_fasta" value="phiX" />
+            <param name="input_bam" value="phiX.bam"/>
+            <param name="reference_source_selector" value="history" />
+            <param name="ref_fasta" value="phiX.fasta" />
             <output name="calmd_output" file="samtools_calmd_out_1.bam" ftype="bam" />
         </test>
         <test>
             <param name="option_sets" value="advanced" /> 
             <param name="change_identical" value="true" />
             <param name="extended_baq" value="true" />
-            <param name="input_bam" value="phiX.bam" dbkey="phiX" />
-            <param name="reference_source|reference_source_selector" value="history" />
-            <param name="ref_fasta" value="phiX.fasta" dbkey="phiX" />
-            <output name="calmd_output" file="samtools_calmd_out_2.bam" ftype="bam" />
-        </test>
-        <!-- Using the test-data-repo's phiX.fa should, as before, produce the same output. -->
-        <test>
-            <param name="option_sets" value="advanced" /> 
-            <param name="change_identical" value="true" />
-            <param name="extended_baq" value="true" />
-            <param name="input_bam" value="phiX.bam" dbkey="phiX" />
-            <param name="reference_source|reference_source_selector" value="cached" />
-            <param name="ref_fasta" value="phiX" />
+            <param name="input_bam" value="phiX.bam"/>
+            <param name="reference_source_selector" value="history" />
+            <param name="ref_fasta" value="phiX.fasta" />
             <output name="calmd_output" file="samtools_calmd_out_2.bam" ftype="bam" />
         </test>
     </tests>
     <help>
 **What it does**
 
-Generate the MD tag. If the MD tag is already present, this command will give a warning if the MD tag generated is different from the existing tag. Outputs a BAM file. 
+Generates the MD tag using ``samtools calmd`` command. If the MD tag (see SAM format refernce below for explanation of SAM/BAM tags) is already present, this command will give a warning if the MD tag generated is different from the existing tag. Outputs a BAM file. The command has the following options::
 
-------
+  -e       change identical bases to '='
+  -A       modify the quality string
+  -r       compute the BQ tag (without -A) or cap baseQ by BAQ (with -A)
+  -E       extended BAQ for better sensitivity but lower specificity
+  
+-----
 
-**Citation**
+**NM and MD tags**
 
-For the underlying tool, please cite `Li H, Handsaker B, Wysoker A, Fennell T, Ruan J, Homer N, Marth G, Abecasis G, Durbin R; 1000 Genome Project Data Processing Subgroup. The Sequence Alignment/Map format and SAMtools. Bioinformatics. 2009 Aug 15;25(16):2078-9. &lt;http://www.ncbi.nlm.nih.gov/pubmed/19505943&gt;`_
-
+From SAM format specification::
 
-If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*
+  MD (string)  String for mismatching positions. Regex : [0-9]+(([A-Z]|\^[A-Z]+)[0-9]+)*7
+  NM (indeger) Edit distance to the reference, including ambiguous bases but excluding clipping
+  
+See refernces for more information about SAM format tags.
 
-        </help>
+    </help>
+    <expand macro="citations"></expand>
 </tool>