diff covstats.xml @ 0:92cdb9130d08 draft default tip

Uploaded
author wolma
date Tue, 09 Dec 2014 17:21:54 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/covstats.xml	Tue Dec 09 17:21:54 2014 -0500
@@ -0,0 +1,30 @@
+<tool id="coverage_stats" name="Coverage Statistics">
+  <description>Calculate coverage statistics for a BCF file as generated by the Variant Calling tool</description>
+  <requirements>
+    <requirement type="package" version="0.1.5">mimodd</requirement>
+  </requirements>
+  <version_command>mimodd version -q</version_command>
+  <command> 
+	mimodd covstats $ifile --ofile $output_vcf
+  </command>
+
+  <inputs>
+      <param name="ifile" type="data" format="bcf" label="BCF input file" help="Use the Variant Calling tool to generate input for this tool."/>
+  </inputs>
+  <outputs>
+    <data name="output_vcf" format="tabular" label="Coverage Statistics for ${on_string}"/>
+  </outputs>
+
+<help>
+.. class:: infomark
+
+   **What it does**
+
+The tool takes as input a BCF file produced by the *Variant Calling* tool, and calculates per-chromosome read coverage from it.
+
+.. class:: warningmark
+
+   The tool treats genome positions missing from the BCF input as zero coverage, so it is safe to use ONLY with BCF files produced by the *Variant Calling* tool or through other commands that keep the information for all sites.
+
+</help>
+</tool>