annotate hetbox.xml @ 7:a777a76205cc draft default tip

Current version - documentation and suppressing error on stderr messages
author nick
date Tue, 04 Jun 2013 00:07:06 -0400
parents d38113d9c4d6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
1 <tool id="hetbox" version="1.0" name="Minor variant boxplot">
3
e9c34ef993d6 Wrote some documentation
nick
parents: 1
diff changeset
2 <description> from allele counts</description>
5
d38113d9c4d6 current xml version
nick
parents: 3
diff changeset
3 <command interpreter="python">hetbox.py $input $outplot $outreport
d38113d9c4d6 current xml version
nick
parents: 3
diff changeset
4 </command>
1
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
5 <inputs>
3
e9c34ef993d6 Wrote some documentation
nick
parents: 1
diff changeset
6 <param name="input" type="data" format="tabular" label="Input allele counts"/>
7
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
7 <param name="report" type="boolean" truevalue="yes" falsevalue="no" checked="True" label="Also produce a text report" />
1
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
8 </inputs>
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
9 <outputs>
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
10 <data name="outplot" format="png"/>
5
d38113d9c4d6 current xml version
nick
parents: 3
diff changeset
11 <data name="outreport" format="tabular">
d38113d9c4d6 current xml version
nick
parents: 3
diff changeset
12 <filter>report is True</filter>
d38113d9c4d6 current xml version
nick
parents: 3
diff changeset
13 </data>
1
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
14 </outputs>
7
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
15 <stdio>
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
16 <exit_code range="1:" err_level="fatal"/>
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
17 <exit_code range=":-1" err_level="fatal"/>
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
18 </stdio>
1
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
19
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
20 <help>
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
21
3
e9c34ef993d6 Wrote some documentation
nick
parents: 1
diff changeset
22 .. class:: infomark
e9c34ef993d6 Wrote some documentation
nick
parents: 1
diff changeset
23
e9c34ef993d6 Wrote some documentation
nick
parents: 1
diff changeset
24 **What it does**
e9c34ef993d6 Wrote some documentation
nick
parents: 1
diff changeset
25
7
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
26 This will create a boxplot from the output of the "Count alleles" tool, showing the number of minor alleles per sample and the distribution of their frequencies (MAF). It can also, optionally, produce a text report with these numbers.
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
27
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
28 .. class:: infomark
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
29
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
30 **The boxplot**
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
31
a777a76205cc Current version - documentation and suppressing error on stderr messages
nick
parents: 5
diff changeset
32 The graphic shows the distribution of the minor allele frequencies as a boxplot per sample. At the bottom of each plot, a count (N) is given of the number of minor alleles in the plot.
3
e9c34ef993d6 Wrote some documentation
nick
parents: 1
diff changeset
33
1
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
34 </help>
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
35
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
36 <requirements>
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
37 <requirement type="package" version="1.7.1">numpy</requirement>
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
38 </requirements>
a85dd9968af9 Uploaded xml
nick
parents:
diff changeset
39 </tool>