annotate cluster.xml @ 5:2108e2dc3d32 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
author devteam
date Thu, 22 Jun 2017 18:38:08 -0400
parents 1e895b74f29f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
5167eb4b30ca Corrected version string.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
1 <tool id="gops_cluster_1" name="Cluster" version="1.0.0">
5
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
2 <description>the intervals of a dataset</description>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
3 <macros>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
4 <import>macros.xml</import>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
5 </macros>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
6 <expand macro="requirements" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
7 <code file="operation_filter.py">
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
8 <hook exec_after_process="exec_after_cluster" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
9 </code>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
10 <command><![CDATA[
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
11 python '$__tool_directory__/gops_cluster.py'
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
12 '$input1'
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
13 '$output'
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
14 -1 ${input1.metadata.chromCol},${input1.metadata.startCol},${input1.metadata.endCol},${input1.metadata.strandCol}
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
15 -d $distance
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
16 -m $minregions
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
17 -o $returntype
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
18 ]]></command>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
19 <inputs>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
20 <param name="input1" type="data" format="interval" label="Cluster intervals of" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
21 <param name="distance" type="integer" value="1" label="Max distance between intervals" help="(bp)" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
22 <param name="minregions" type="integer" value="2" label="Min number of intervals per cluster" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
23 <param name="returntype" type="select" label="Return type">
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
24 <option value="1">Merge clusters into single intervals</option>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
25 <option value="2">Find cluster intervals; preserve comments and order</option>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
26 <option value="3">Find cluster intervals; output grouped by clusters</option>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
27 <option value="4">Find the smallest interval in each cluster</option>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
28 <option value="5">Find the largest interval in each cluster</option>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
29 </param>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
30 </inputs>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
31 <outputs>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
32 <data name="output" format_source="input1" metadata_source="input1" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
33 </outputs>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
34 <tests>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
35 <test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
36 <param name="input1" value="5.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
37 <param name="distance" value="1" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
38 <param name="minregions" value="2" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
39 <param name="returntype" value="1" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
40 <output name="output" file="gops-cluster-1.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
41 </test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
42 <test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
43 <param name="input1" value="gops_cluster_bigint.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
44 <param name="distance" value="1" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
45 <param name="minregions" value="2" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
46 <param name="returntype" value="1" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
47 <output name="output" file="gops-cluster-1.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
48 </test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
49 <test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
50 <param name="input1" value="5.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
51 <param name="distance" value="1" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
52 <param name="minregions" value="2" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
53 <param name="returntype" value="2" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
54 <output name="output" file="gops-cluster-2.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
55 </test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
56 <test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
57 <param name="input1" value="5.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
58 <param name="distance" value="1" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
59 <param name="minregions" value="2" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
60 <param name="returntype" value="3" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
61 <output name="output" file="gops-cluster-3.bed" />
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
62 </test>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
63 </tests>
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
64 <help><![CDATA[
0
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
65 .. class:: infomark
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
66
45fb880ab3bf 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.
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
68
5
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
69 @SCREENCASTS@
0
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
70
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
71 **Syntax**
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
72
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
73 - **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.
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
74 - **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.
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
75 - **Merge clusters into single intervals** outputs intervals that span the entire cluster.
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
76 - **Find cluster intervals; preserve comments and order** filters out non-cluster intervals while maintaining the original ordering and comments in the file.
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
77 - **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.
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
78
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
79 -----
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
80
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
81 **Examples**
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
82
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
83 Find Clusters:
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
84
2
e84cc9cf3ba1 Added tool images.
devteam <devteam@galaxyproject.org>
parents: 1
diff changeset
85 .. image:: gops_clusterFind.gif
0
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
86
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
87 Merge Clusters:
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
88
2
e84cc9cf3ba1 Added tool images.
devteam <devteam@galaxyproject.org>
parents: 1
diff changeset
89 .. image:: gops_clusterMerge.gif
5
2108e2dc3d32 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/cluster commit cae3e05d02e60f595bb8b6d77a84f030e9bd1689
devteam
parents: 3
diff changeset
90 ]]></help>
0
45fb880ab3bf Imported from capsule None
devteam
parents:
diff changeset
91 </tool>