annotate intersect.xml @ 3:5f72be09cfd3 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/intersect commit a1517c9d22029095120643bbe2c8fa53754dd2b7
author devteam
date Wed, 11 Nov 2015 12:48:44 -0500
parents 77641d5731c8
children 33b3f3688db4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
81ad85f731b9 Corrected version string.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
1 <tool id="gops_intersect_1" name="Intersect" version="1.0.0">
0
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
2 <description>the intervals of two datasets</description>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="0.7.1">bx-python</requirement>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
5 <requirement type="package" version="1.0.0">galaxy-ops</requirement>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
6 </requirements>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
7 <command interpreter="python">gops_intersect.py
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
8 $input1 $input2 $output
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
9
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
10 #if isinstance( $input1.datatype, $__app__.datatypes_registry.get_datatype_by_extension('gff').__class__):
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
11 -1 1,4,5,7 --gff1
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
12 #else:
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
13 -1 ${input1.metadata.chromCol},${input1.metadata.startCol},${input1.metadata.endCol},${input1.metadata.strandCol}
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
14 #end if
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
15
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
16 #if isinstance( $input2.datatype, $__app__.datatypes_registry.get_datatype_by_extension('gff').__class__):
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
17 -2 1,4,5,7 --gff2
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
18 #else:
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
19 -2 ${input2.metadata.chromCol},${input2.metadata.startCol},${input2.metadata.endCol},${input2.metadata.strandCol}
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
20 #end if
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
21
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
22 -m $min $returntype
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
23 </command>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
24 <inputs>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
25 <param name="returntype" type="select" label="Return" help="(see figure below)">
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
26 <option value="">Overlapping Intervals</option>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
27 <option value="-p">Overlapping pieces of Intervals</option>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
28 </param>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
29 <param format="interval,gff" name="input1" type="data" help="First dataset">
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
30 <label>of</label>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
31 </param>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
32 <param format="interval,gff" name="input2" type="data" help="Second dataset">
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
33 <label>that intersect</label>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
34 </param>
3
5f72be09cfd3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/gops/intersect commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 2
diff changeset
35 <param name="min" type="integer" value="1" min="1" help="(bp)">
0
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
36 <label>for at least</label>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
37 </param>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
38 </inputs>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
39 <outputs>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
40 <data format="input" name="output" metadata_source="input1"/>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
41 </outputs>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
42 <code file="operation_filter.py"/>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
43 <trackster_conf/>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
44 <tests>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
45 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
46 <param name="input1" value="1.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
47 <param name="input2" value="2.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
48 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
49 <param name="returntype" value="" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
50 <output name="output" file="gops_intersect_out.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
51 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
52 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
53 <param name="input1" value="1.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
54 <param name="input2" value="2_mod.bed" ftype="interval"/>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
55 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
56 <param name="returntype" value="" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
57 <output name="output" file="gops_intersect_diffCols.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
58 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
59 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
60 <param name="input1" value="1.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
61 <param name="input2" value="2_mod.bed" ftype="interval"/>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
62 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
63 <param name="returntype" value="Overlapping pieces of Intervals" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
64 <output name="output" file="gops_intersect_p_diffCols.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
65 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
66 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
67 <param name="input1" value="1.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
68 <param name="input2" value="2.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
69 <param name="min" value="10" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
70 <param name="returntype" value="Overlapping pieces of Intervals" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
71 <output name="output" file="gops_intersect_p_out.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
72 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
73 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
74 <param name="input1" value="gops_bigint.interval" ftype="interval" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
75 <param name="input2" value="gops_bigint2.interval" ftype="interval" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
76 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
77 <param name="returntype" value="" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
78 <output name="output" file="gops_intersect_bigint_out.interval" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
79 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
80 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
81 <param name="input1" value="gops_bigint2.interval" ftype="interval" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
82 <param name="input2" value="gops_bigint.interval" ftype="interval" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
83 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
84 <param name="returntype" value="" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
85 <output name="output" file="gops_intersect_bigint_out.interval" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
86 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
87 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
88 <param name="input1" value="12.bed" ftype="bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
89 <param name="input2" value="1.bed" ftype="bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
90 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
91 <param name="returntype" value="" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
92 <output name="output" file="gops_intersect_no_strand_out.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
93 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
94 <!-- Intersect two GFF files. -->
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
95 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
96 <param name="input1" value="gops_subtract_in1.gff" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
97 <param name="input2" value="gops_subtract_in2.gff" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
98 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
99 <param name="returntype" value="" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
100 <output name="output" file="gops_intersect_out2.gff" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
101 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
102 <!-- Intersect GFF file and bed file. -->
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
103 <test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
104 <param name="input1" value="gops_subtract_in1.gff" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
105 <param name="input2" value="gops_subtract_in2.bed" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
106 <param name="min" value="1" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
107 <param name="returntype" value="" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
108 <output name="output" file="gops_intersect_out2.gff" />
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
109 </test>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
110
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
111 </tests>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
112 <help>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
113
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
114 .. class:: infomark
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
115
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
116 **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.
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
117
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
118 -----
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
119
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
120 **Screencasts!**
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
121
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
122 See Galaxy Interval Operation Screencasts_ (right click to open this link in another window).
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
123
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
124 .. _Screencasts: http://wiki.g2.bx.psu.edu/Learn/Interval%20Operations
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
125
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
126 -----
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
127
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
128 **Syntax**
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
129
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
130 - **Where overlap is at least** sets the minimum length (in base pairs) of overlap between elements of the two datasets
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
131 - **Overlapping Intervals** returns entire intervals from the first dataset that overlap the second dataset. The returned intervals are completely unchanged, and this option only filters out intervals that do not overlap with the second dataset.
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
132 - **Overlapping pieces of Intervals** returns intervals that indicate the exact base pair overlap between the first dataset and the second dataset. The intervals returned are from the first dataset, and all fields besides start and end are guaranteed to remain unchanged.
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
133
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
134 -----
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
135
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
136 **Examples**
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
137
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
138 Overlapping Intervals:
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
139
2
77641d5731c8 Added tool images.
devteam <devteam@galaxyproject.org>
parents: 1
diff changeset
140 .. image:: gops_intersectOverlappingIntervals.gif
0
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
141
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
142 Overlapping Pieces of Intervals:
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
143
2
77641d5731c8 Added tool images.
devteam <devteam@galaxyproject.org>
parents: 1
diff changeset
144 .. image:: gops_intersectOverlappingPieces.gif
0
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
145
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
146 </help>
5b3c6135a982 Imported from capsule None
devteam
parents:
diff changeset
147 </tool>