annotate WeightedAverage.xml @ 1:68a40b074399 draft default tip

Uploaded corrected tool requirements definition.
author devteam
date Thu, 03 Apr 2014 09:34:00 -0400
parents e11314245c2a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="wtavg" name="Assign weighted-average" version="1.0.0">
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
2 <description> of the values of features overlapping an interval </description>
1
68a40b074399 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
3 <requirements>
68a40b074399 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
4 <requirement type="package" version="1.0.0">galaxy-ops</requirement>
68a40b074399 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
5 <requirement type="package" version="0.7.1">bx-python</requirement>
68a40b074399 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
6 </requirements>
0
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
7 <command interpreter="python">WeightedAverage.py $genomic_interval $genomic_feature $out_file1 -1 ${genomic_interval.metadata.chromCol},${genomic_interval.metadata.startCol},${genomic_interval.metadata.endCol},${genomic_interval.metadata.strandCol} -2 ${genomic_feature.metadata.chromCol},${genomic_feature.metadata.startCol},${genomic_feature.metadata.endCol},${genomic_feature.metadata.strandCol},${genomic_feature.metadata.nameCol}</command>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
8
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
9 <inputs>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
10 <param format="interval" name="genomic_interval" type="data" label="Genomic intervals (first dataset)" help="Dataset missing? See Note below."/>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
11 <param format="interval" name="genomic_feature" label="Genomic features (second dataset)" type="data" help="Make sure the value column is specified. See Note below." />
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
12 </inputs>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
13 <outputs>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
14 <data format="input" name="out_file1" metadata_source="genomic_interval" />
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
15 </outputs>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
16 <tests>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
17 <!-- Test data with valid values -->
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
18 <test>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
19 <param name="genomic_interval" value="interval_interpolate.bed"/>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
20 <param name="genomic_feature" value="value_interpolate.bed"/>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
21 <output name="out_file1" file="interpolate_result.bed"/>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
22 </test>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
23
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
24 </tests>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
25 <help>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
26
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
27
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
28 .. class:: infomark
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
29
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
30 **What it does**
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
31
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
32 For each interval in your first dataset, this tool calculates the weighted average value of the overlapping features in your second dataset.
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
33
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
34 - When a genomic interval partially or totally overlaps a single genomic feature, the value of that genomic feature is assigned to the genomic interval.
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
35 - When a genomic interval partially or totally overlaps with more than one genomic features, the average of the values of the overlapping genomic features weighted by the corresponding number of overlapping bases is assigned to the genomic interval.
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
36 - When a genomic interval does not overlap with any genomic feature, 'NA' will be assigned as it's value.
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
37
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
38 -----
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
39
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
40 .. class:: warningmark
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
41
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
42 **Note**
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
43
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
44 The input datasets should be in **bed** or **interval** format. Please use "edit attributes"/pencil icon to specify the column containing the values for the features in the second dataset as **name/identifier** column.
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
45
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
46 The output will contain all the columns in the first input plus a new column containing the assigned value for each interval.
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
47
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
48 -----
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
49
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
50 **Example**
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
51
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
52 - Suppose our first dataset contains the following **genomic intervals**::
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
53
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
54 chr start stop
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
55 chr1 1000 2000
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
56 chr1 3000 5000
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
57 chr1 8000 9000
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
58
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
59 - and our second dataset contains the following **genomic features** each having an associated value (in fourth column) ::
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
60
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
61 chr start stop name
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
62 chr1 900 1200 0.5
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
63 chr1 2900 3100 0.2
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
64 chr1 4800 5100 0.8
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
65
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
66 - For each **genomic interval** in our first dataset, this tool calculates the weighted average value of the overlapping **genomic features** in our second dataset ::
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
67
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
68 chr1 1000 2000 0.5
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
69 chr1 3000 5000 0.6
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
70 chr1 8000 9000 NA
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
71
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
72
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
73
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
74 </help>
e11314245c2a Imported from capsule None
devteam
parents:
diff changeset
75 </tool>