annotate WeightedAverage.xml @ 1:90611e86a998 draft

Uploaded corrected tool requirements definition.
author devteam
date Thu, 03 Apr 2014 09:34:41 -0400
parents 9b7b4009f2c0
children efa2b391e887
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="wtavg" name="Assign weighted-average" version="1.0.0">
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
2 <description> of the values of features overlapping an interval </description>
1
90611e86a998 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
3 <requirements>
90611e86a998 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
4 <requirement type="package" version="1.0.0">galaxy-ops</requirement>
90611e86a998 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
5 <requirement type="package" version="0.7.1">bx-python</requirement>
90611e86a998 Uploaded corrected tool requirements definition.
devteam
parents: 0
diff changeset
6 </requirements>
0
9b7b4009f2c0 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>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
8
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
9 <inputs>
9b7b4009f2c0 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."/>
9b7b4009f2c0 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." />
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
12 </inputs>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
13 <outputs>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
14 <data format="input" name="out_file1" metadata_source="genomic_interval" />
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
15 </outputs>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
16 <tests>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
17 <!-- Test data with valid values -->
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
18 <test>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
19 <param name="genomic_interval" value="interval_interpolate.bed"/>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
20 <param name="genomic_feature" value="value_interpolate.bed"/>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
21 <output name="out_file1" file="interpolate_result.bed"/>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
22 </test>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
23
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
24 </tests>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
25 <help>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
26
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
27
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
28 .. class:: infomark
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
29
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
30 **What it does**
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
31
9b7b4009f2c0 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.
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
33
9b7b4009f2c0 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.
9b7b4009f2c0 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.
9b7b4009f2c0 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.
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
37
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
38 -----
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
39
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
40 .. class:: warningmark
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
41
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
42 **Note**
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
43
9b7b4009f2c0 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.
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
45
9b7b4009f2c0 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.
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
47
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
48 -----
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
49
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
50 **Example**
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
51
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
52 - Suppose our first dataset contains the following **genomic intervals**::
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
53
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
54 chr start stop
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
55 chr1 1000 2000
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
56 chr1 3000 5000
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
57 chr1 8000 9000
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
58
9b7b4009f2c0 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) ::
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
60
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
61 chr start stop name
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
62 chr1 900 1200 0.5
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
63 chr1 2900 3100 0.2
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
64 chr1 4800 5100 0.8
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
65
9b7b4009f2c0 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 ::
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
67
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
68 chr1 1000 2000 0.5
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
69 chr1 3000 5000 0.6
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
70 chr1 8000 9000 NA
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
71
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
72
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
73
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
74 </help>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
75 </tool>