annotate cluster.xml @ 1:9fcc3a1c3d26

Corrected version string.
author devteam <devteam@galaxyproject.org>
date Thu, 10 Apr 2014 13:47:30 -0400
parents d5677eecbad4
children 520de69b107a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
9fcc3a1c3d26 Corrected version string.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
1 <tool id="gops_cluster_1" name="Cluster" version="1.0.0">
0
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
2 <description>the intervals of a dataset</description>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="0.7.1">bx-python</requirement>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="1.0.0">galaxy-ops</requirement>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
6 </requirements>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
7 <trackster_conf/>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
8 <command interpreter="python">gops_cluster.py $input1 $output -1 ${input1.metadata.chromCol},${input1.metadata.startCol},${input1.metadata.endCol},${input1.metadata.strandCol} -d $distance -m $minregions -o $returntype</command>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
9 <inputs>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
10 <param format="interval" name="input1" type="data">
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
11 <label>Cluster intervals of</label>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
12 </param>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
13 <param name="distance" size="5" type="integer" value="1" help="(bp)">
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
14 <label>max distance between intervals</label>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
15 </param>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
16 <param name="minregions" size="5" type="integer" value="2">
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
17 <label>min number of intervals per cluster</label>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
18 </param>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
19 <param name="returntype" type="select" label="Return type">
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
20 <option value="1">Merge clusters into single intervals</option>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
21 <option value="2">Find cluster intervals; preserve comments and order</option>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
22 <option value="3">Find cluster intervals; output grouped by clusters</option>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
23 <option value="4">Find the smallest interval in each cluster</option>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
24 <option value="5">Find the largest interval in each cluster</option>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
25 </param>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
26 </inputs>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
27 <outputs>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
28 <data format="input" name="output" metadata_source="input1" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
29 </outputs>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
30 <code file="operation_filter.py">
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
31 <hook exec_after_process="exec_after_cluster" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
32 </code>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
33 <tests>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
34 <test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
35 <param name="input1" value="5.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
36 <param name="distance" value="1" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
37 <param name="minregions" value="2" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
38 <param name="returntype" value="1" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
39 <output name="output" file="gops-cluster-1.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
40 </test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
41 <test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
42 <param name="input1" value="gops_cluster_bigint.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
43 <param name="distance" value="1" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
44 <param name="minregions" value="2" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
45 <param name="returntype" value="1" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
46 <output name="output" file="gops-cluster-1.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
47 </test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
48 <test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
49 <param name="input1" value="5.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
50 <param name="distance" value="1" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
51 <param name="minregions" value="2" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
52 <param name="returntype" value="2" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
53 <output name="output" file="gops-cluster-2.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
54 </test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
55 <test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
56 <param name="input1" value="5.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
57 <param name="distance" value="1" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
58 <param name="minregions" value="2" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
59 <param name="returntype" value="3" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
60 <output name="output" file="gops-cluster-3.bed" />
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
61 </test>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
62 </tests>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
63 <help>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
64
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
65 .. class:: infomark
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
66
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
67 **TIP:** If your dataset does not appear in the pulldown menu, it means that it is not in interval format. Use "edit attributes" to set chromosome, start, end, and strand columns.
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
68
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
69 -----
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
70
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
71 **Screencasts!**
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
72
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
73 See Galaxy Interval Operation Screencasts_ (right click to open this link in another window).
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
74
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
75 .. _Screencasts: http://wiki.g2.bx.psu.edu/Learn/Interval%20Operations
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
76
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
77 -----
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
78
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
79 **Syntax**
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
80
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
81 - **Maximum distance** is greatest distance in base pairs allowed between intervals that will be considered &quot;clustered&quot;. **Negative** values for distance are allowed, and are useful for clustering intervals that overlap.
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
82 - **Minimum intervals per cluster** allow a threshold to be set on the minimum number of intervals to be considered a cluster. Any area with less than this minimum will not be included in the output.
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
83 - **Merge clusters into single intervals** outputs intervals that span the entire cluster.
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
84 - **Find cluster intervals; preserve comments and order** filters out non-cluster intervals while maintaining the original ordering and comments in the file.
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
85 - **Find cluster intervals; output grouped by clusters** filters out non-cluster intervals, but outputs the cluster intervals so that they are grouped together. Comments and original ordering in the file are lost.
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
86
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
87 -----
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
88
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
89 **Examples**
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
90
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
91 Find Clusters:
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
92
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
93 .. image:: ${static_path}/operation_icons/gops_clusterFind.gif
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
94
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
95 Merge Clusters:
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
96
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
97 .. image:: ${static_path}/operation_icons/gops_clusterMerge.gif
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
98
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
99 </help>
d5677eecbad4 Imported from capsule None
devteam
parents:
diff changeset
100 </tool>