annotate tools/indels/indel_table.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="indel_table" name="Indel Analysis Table" version="1.0.0">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>for combining indel interval data</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 indel_table.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 --input1=$input1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 --sum1=$sum1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 --input2=$input2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 --sum2=$sum2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 --output=$output1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 #for $i in $inputs
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 ${i.input}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 ${i.sum}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 #end for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <param format="interval" name="input1" type="data" label="Select first file to add" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <param name="sum1" type="boolean" checked="true" truevalue="true" falsevalue="false" label="Include first file's totals in overall total" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <param format="interval" name="input2" type="data" label="Select second file to add" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <param name="sum2" type="boolean" checked="true" truevalue="true" falsevalue="false" label="Include second file's totals in overall total" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <repeat name="inputs" title="Input Files">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <param name="input" label="Add file" type="data" format="interval" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name="sum" type="boolean" checked="true" truevalue="true" falsevalue="false" label="Include file's totals in overall total" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 </repeat>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <data format="interval" name="output1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name="input1" value="indel_table_in1.interval" ftype="interval" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <param name="sum1" value="true"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <param name="input2" value="indel_table_in2.interval" ftype="interval" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <param name="sum2" value="true" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <param name="input" value="indel_table_in3.interval" ftype="interval" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <param name="sum" value="true" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <output name="output1" file="indel_table_out1.interval" ftype="interval" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 Creates a table allowing for analysis and comparison of indel data. Combines any number of interval files that have been produced by the tool that converts indel SAM data to interval format. Includes overall total counts for all or some files. The tool has the option to not include a given file's counts in the total column. This could be useful for combined data if the counts for certain indels might be included more than once.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 The exact columns of the output will depend on the columns of the input. Here is the detailed specification of the output columns::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 Column Description
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 ------------------------------- ----------------------------------------------------------------------------------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 1 ... m "Indel" All the "indel" columns, which contain the info that will be checked for equality
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 m + 1 Total Occurrences Total number of occurrences of this indel across all (included) files
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 m + 2 Occurrences for File 1 Number of occurrences of this indel for first file
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 m + 3 Occurrences for File 2 Number of occurrences of this indel for second file
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 [m + ...] [...] [Number of occurrences of this indel for ... file]
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 The most likely columns would be from the output of the Convert SAM to Interval/BED tool, so: Chromosome, Start position, End position, I/D (Insertion/Deletion), -/&lt;base(s)&gt; (Deletion/Inserted base(s)), Total Occurrences (across files), Occurrences for File 1, Occurrences for File 2, etc. See below for an example.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 Suppose you have the following 4 files::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 chrM 300 301 D - 6
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 chrM 303 304 D - 19
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 chrM 359 360 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 chrM 410 411 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 chrM 435 436 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 chrM 410 411 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 chrM 714 715 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 chrM 995 997 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 chrM 1168 1169 I A 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 chrM 1296 1297 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 chrM 300 301 D - 8
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 chrM 525 526 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 chrM 958 959 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 chrM 995 996 D - 3
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 chrM 1168 1169 I C 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 chrM 1296 1297 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 chrM 303 304 D - 22
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 chrM 410 411 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 chrM 435 436 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 chrM 714 715 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 chrM 753 754 I A 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 chrM 1168 1169 I A 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 and the fifth file::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 chrM 303 304 D - 22
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 chrM 410 411 D - 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 chrM 435 436 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 chrM 714 715 D - 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 chrM 753 754 I A 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 chrM 995 997 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 chrM 1168 1169 I A 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 chrM 1296 1297 D - 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 The following will be produced if you include the first four files in the sum, but not the fifth::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 chrM 300 301 D - 14 6 0 8 0 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 chrM 303 304 D - 41 19 0 0 22 22
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105 chrM 359 360 D - 1 1 0 0 0 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106 chrM 410 411 D - 3 1 1 0 1 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107 chrM 435 436 D - 2 1 0 0 1 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108 chrM 525 526 D - 1 0 0 1 0 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109 chrM 714 715 D - 2 0 1 0 1 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110 chrM 753 754 I A 1 0 0 0 1 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111 chrM 958 959 D - 1 0 0 1 0 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112 chrM 995 996 D - 3 0 0 3 0 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
113 chrM 995 997 D - 1 0 1 0 0 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
114 chrM 1168 1169 I A 2 0 1 0 1 2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
115 chrM 1168 1169 I C 1 0 0 1 0 0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
116 chrM 1296 1297 D - 2 0 1 1 0 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
117
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
118 The first numeric column includes the total or the next four columns, but not the fifth.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
119
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
120
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
121 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
122 </tool>