annotate hetbox.xml @ 0:8d2c4c11fd8f draft default tip

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