annotate hetbox.xml @ 4:1c21e9f3104b draft default tip

updated script comments and remove "evaluation" column of the report
author boris
date Tue, 25 Jun 2013 00:51:35 -0400
parents 479f860eb8a9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
1 <tool id="hetbox" version="1.0" name="MAF boxplot">
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
2 <description></description>
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
3 <requirements>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
4 <requirement type="package" version="2.15.0">R</requirement>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
5 <requirement type="package" version="2.2.6">rpy2</requirement>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
6 <requirement type="package" version="1.7.1">numpy</requirement>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
7 </requirements>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
8 <command interpreter="python">hetbox.py $input $outplot $outreport
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
9 </command>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
10 <inputs>
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
11 <param name="input" type="data" format="tabular" label="Input allele counts table"/>
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
12 <param name="report" type="boolean" truevalue="yes" falsevalue="no" checked="True" label="Also generate a report on data spread" />
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
13 </inputs>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
14 <outputs>
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
15 <data name="outplot" format="png" label="${tool.name} on ${on_string}: boxplot"/>
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
16 <data name="outreport" format="tabular" label="${tool.name} on ${on_string}: report">
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
17 <filter>report is True</filter>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
18 </data>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
19 </outputs>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
20 <stdio>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
21 <exit_code range="1:" err_level="fatal"/>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
22 <exit_code range=":-1" err_level="fatal"/>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
23 </stdio>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
24
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
25 <help>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
26
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
27 .. class:: infomark
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
28
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
29 **What it does**
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
30
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
31 The MAF Boxplot tool takes a table listing heteroplasmic sites per sample and their corresponding minor allele frequency.
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
32 It generates a boxplot of the minor allele frequencies per sample by default.
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
33 Optionally, it can generate a report including the total number of heteroplasmic sites and the median and the median absolute deviation (MAD) of the minor allele frequencies per sample.
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
34
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
35 -----
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
36
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
37 .. class:: warningmark
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
38
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
39 **Note**
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
40
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
41 Please, follow the format described below for the input file:
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
42
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
43 -----
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
44
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
45 .. class:: infomark
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
46
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
47 **Formats**
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
48
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
49 **Count alleles tool output format**
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
50
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
51 Columns::
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
52
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
53 1. sample id
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
54 2. chromosome
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
55 3. position
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
56 4 counts for A's
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
57 5. counts for C's
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
58 6. counts for G's
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
59 7. counts for T's
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
60 8. Coverage
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
61 9. Number of alleles passing frequency threshold
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
62 10. Major allele
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
63 11. Minor allele
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
64 12. Minor allele frequency in position
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
65
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
66 -----
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
67
3
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
68 **Citation**
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
69
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
70 If you use this tool, please cite Dickins B, Rebolledo-Jaramillo B, et al. *In preparation.*
479f860eb8a9 updated tool xml description
boris
parents: 1
diff changeset
71 (boris-at-bx.psu.edu)
1
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
72
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
73
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
74 </help>
b4f9a4f2f65d Uploaded xml
boris
parents:
diff changeset
75 </tool>