annotate covstats.xml @ 0:6231ae8f87b8

Uploaded
author wolma
date Wed, 11 Feb 2015 08:29:02 -0500
parents
children a548b3c6ed00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
1 <tool id="coverage_stats" name="Coverage Statistics">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
2 <description>Calculate coverage statistics for a BCF file as generated by the Variant Calling tool</description>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
3 <version_command>mimodd version -q</version_command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
4 <command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
5 mimodd covstats "$ifile" --ofile "$output_vcf"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
6 </command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
7
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
8 <inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
9 <param name="ifile" type="data" format="bcf" label="BCF input file" help="Use the Variant Calling tool to generate input for this tool."/>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
10 </inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
11 <outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
12 <data name="output_vcf" format="tabular" label="Coverage Statistics for ${on_string}"/>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
13 </outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
14
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
15 <help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
16 .. class:: infomark
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
17
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
18 **What it does**
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
19
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
20 The tool takes as input a BCF file produced by the *Variant Calling* tool, and calculates per-chromosome read coverage from it.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
21
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
22 .. class:: warningmark
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
23
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
24 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.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
25
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
26 </help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
27 </tool>