annotate featureCounter.xml @ 0:ac6218e2b686 draft default tip

Imported from capsule None
author devteam
date Tue, 01 Apr 2014 10:51:34 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="featureCoverage1" name="Feature coverage" version="2.0.0">
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="0.7.1">bx-python</requirement>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="1.0.0">galaxy-ops</requirement>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
6 </requirements>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
7 <command interpreter="python">featureCounter.py $input1 $input2 $output -1 ${input1.metadata.chromCol},${input1.metadata.startCol},${input1.metadata.endCol},${input1.metadata.strandCol} -2 ${input2.metadata.chromCol},${input2.metadata.startCol},${input2.metadata.endCol},${input2.metadata.strandCol}</command>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
8 <inputs>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
9 <param format="interval" name="input1" type="data" help="First dataset">
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
10 <label>What portion of</label>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
11 </param>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
12 <param format="interval" name="input2" type="data" help="Second dataset">
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
13 <label>is covered by</label>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
14 </param>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
15 </inputs>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
16 <outputs>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
17 <data format="interval" name="output" metadata_source="input1" />
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
18 </outputs>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
19
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
20 <tests>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
21 <test>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
22 <param name="input1" value="1.bed" />
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
23 <param name="input2" value="2.bed" />
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
24 <output name="output" file="6_feature_coverage.bed" />
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
25 </test>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
26 <test>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
27 <param name="input1" value="chrY1.bed" />
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
28 <param name="input2" value="chrY2.bed" />
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
29 <output name="output" file="chrY_Coverage.bed" />
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
30 </test>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
31 </tests>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
32 <help>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
33
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
34 .. class:: infomark
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
35
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
36 **What it does**
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
37
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
38 This tool finds the coverage of intervals in the first dataset on intervals in the second dataset. The coverage and count are appended as 4 new columns in the resulting dataset.
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
39
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
40 -----
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
41
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
42 **Example**
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
43
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
44 - If **First dataset** consists of the following windows::
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
45
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
46 chrX 1 10001 seg 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
47 chrX 10001 20001 seg 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
48 chrX 20001 30001 seg 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
49 chrX 30001 40001 seg 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
50
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
51 - and **Second dataset** consists of the following exons::
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
52
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
53 chrX 5000 6000 seg2 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
54 chrX 5500 7000 seg2 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
55 chrX 9000 22000 seg2 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
56 chrX 24000 34000 seg2 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
57 chrX 36000 38000 seg2 0 -
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
58
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
59 - the **Result** is the coverage of exons of the second dataset in each of the windows contained in first dataset::
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
60
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
61 chrX 1 10001 seg 0 - 3001 0.3001 2 1
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
62 chrX 10001 20001 seg 0 - 10000 1.0 1 0
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
63 chrX 20001 30001 seg 0 - 8000 0.8 0 2
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
64 chrX 30001 40001 seg 0 - 5999 0.5999 1 1
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
65
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
66 - To clarify, the following line of output ( added columns are indexed by a, b and c )::
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
67
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
68 a b c d
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
69 chrX 1 10001 seg 0 - 3001 0.3001 2 1
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
70
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
71 implies that 2 exons (c) fall fully in this window (chrX:1-10001), 1 exon (d) partially overlaps this window, and these 3 exons cover 30.01% (c) of the window size, spanning 3001 nucleotides (a).
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
72
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
73 * a: number of nucleotides in this window covered by the features in (c) and (d) - features overlapping with each other will be merged to calculate (a)
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
74 * b: fraction of window size covered by features in (c) and (d) - features overlapping with each other will be merged to calculate (b)
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
75 * c: number of features in the 2nd dataset that fall **completely** within this window
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
76 * d: number of features in the 2nd dataset that **partially** overlap this window
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
77
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
78 </help>
ac6218e2b686 Imported from capsule None
devteam
parents:
diff changeset
79 </tool>