annotate WeightedAverage.xml @ 2:efa2b391e887 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
author devteam
date Wed, 05 Oct 2016 13:39:38 -0400
parents 90611e86a998
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
1 <tool id="wtavg" name="Assign weighted-average" version="1.0.1">
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>
2
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
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} ${allow_zeros}</command>
0
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." />
2
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
12 <param name="allow_zeros" label="Include zeros in calculations" type="boolean" help="Otherwise, skip them as bad values" truevalue="--allow_zeros" falsevalue="" checked="True" />
0
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
13 </inputs>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
14 <outputs>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
15 <data format="input" name="out_file1" metadata_source="genomic_interval" />
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
16 </outputs>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
17 <tests>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
18 <!-- Test data with valid values -->
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
19 <test>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
20 <param name="genomic_interval" value="interval_interpolate.bed"/>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
21 <param name="genomic_feature" value="value_interpolate.bed"/>
2
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
22 <param name="allow_zeros" value="False" />
0
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
23 <output name="out_file1" file="interpolate_result.bed"/>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
24 </test>
2
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
25 <test>
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
26 <param name="genomic_interval" value="interval_interpolate.bed"/>
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
27 <param name="genomic_feature" value="value_interpolate.bed"/>
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
28 <param name="allow_zeros" value="True" />
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
29 <output name="out_file1" file="interpolate_result_zeros.bed"/>
efa2b391e887 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/weightedaverage commit f770c3c58f1e7e1fa5ed22d7f7aca856d36729e8
devteam
parents: 1
diff changeset
30 </test>
0
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
31 </tests>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
32 <help>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
33
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
34
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
35 .. class:: infomark
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
36
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
37 **What it does**
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
38
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
39 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
40
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
41 - 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
42 - 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
43 - 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
44
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
45 -----
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
46
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
47 .. class:: warningmark
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
48
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
49 **Note**
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
50
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
51 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
52
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
53 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
54
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
55 -----
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
56
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
57 **Example**
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
58
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
59 - Suppose our first dataset contains the following **genomic intervals**::
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
60
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
61 chr start stop
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
62 chr1 1000 2000
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
63 chr1 3000 5000
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
64 chr1 8000 9000
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
65
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
66 - 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
67
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
68 chr start stop name
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
69 chr1 900 1200 0.5
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
70 chr1 2900 3100 0.2
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
71 chr1 4800 5100 0.8
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
72
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
73 - 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
74
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
75 chr1 1000 2000 0.5
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
76 chr1 3000 5000 0.6
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
77 chr1 8000 9000 NA
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
78
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
79
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
80
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
81 </help>
9b7b4009f2c0 Imported from capsule None
devteam
parents:
diff changeset
82 </tool>