annotate macros.xml @ 15:ce2f9b4e4e7c draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0d7fcf576fd797327af90538b216473ef13daa41
author iuc
date Sat, 23 May 2015 22:48:56 -0400
parents 38516915ccaf
children e30113df8cf6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
1 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
2 <xml name="requirements">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <requirements>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <requirement type="package" version="2.22">bedtools</requirement>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 <yield/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 </requirements>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <token name="@WRAPPER_VERSION@">2.22</token>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
9 <xml name="stdio">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
10 <stdio>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
11 <!-- Anything other than zero is an error -->
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
12 <exit_code range="1:" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
13 <exit_code range=":-1" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
14 <!-- In case the return code has not been set propery check stderr too -->
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 <regex match="Error:" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 <regex match="Exception:" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 </stdio>
12
542d2008a462 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 344140b8df53b8b7024618bb04594607a045c03a
iuc
parents: 8
diff changeset
18 <version_command>bedtools --version</version_command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 <xml name="reciprocal">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 <param name="reciprocal" type="boolean" checked="false" truevalue="-r" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 label="Require that the fraction of overlap be reciprocal for A and B"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 help="In other words, if -f is 0.90 and -r is used, this requires that B overlap at least 90% of A and that A also overlaps at least 90% of B. (-r)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <xml name="overlap">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <param name="overlap" type="float" value="0.000000001" label="Minimum overlap required as a fraction of A" help="Default is 1E-9, i.e. 1bp. (-f)"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 <xml name="strand2">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 <param name="strand" type="select" label="Calculation based on strandedness?">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 <option value="" selected="True">Overlaps on either strand</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 <option value="-s">Only overlaps occurring on the **same** strand.</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 <option value="-S">Only overlaps occurring on the **opposite** strand.</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <xml name="seed">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <conditional name="seed">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <param name="seed_choose" type="select" label="Choose Seed?" help="(-seed)">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <option value="False" selected="True">Random Shuffling</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <option value="True">Choose fixed seed</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <when value="True">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <param name="seed" type="integer" value="12345" label="Enter Seed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 <when value="False" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 </conditional>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <xml name="split">
12
542d2008a462 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 344140b8df53b8b7024618bb04594607a045c03a
iuc
parents: 8
diff changeset
48 <param name="split" type="boolean" checked="false" truevalue="-split" falsevalue=""
542d2008a462 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 344140b8df53b8b7024618bb04594607a045c03a
iuc
parents: 8
diff changeset
49 label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage."
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 help="If set, the coverage will be calculated based the spliced intervals only. For BAM files, this inspects the CIGAR N operation to infer the blocks for computing coverage. For BED12 files, this inspects the BlockCount, BlockStarts, and BlockEnds fields (i.e., columns 10,11,12). If this option is not set, coverage will be calculated based on the interval's START/END coordinates, and would include introns in the case of RNAseq data. (-split)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 <xml name="genome">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 <param format="tabular" name="genome" type="data" label="Genome file" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 <!--TODO: make use of: ${chromInfo} -->
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 <xml name="addition">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 <conditional name="addition">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 <param name="addition_select" type="select" label="Choose what you want to do">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 <option value="b" selected="True">Increase the BED/GFF/VCF entry by the same number base pairs in each direction.</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 <option value="lr">Increase by Start Coordinate and End Coordinate</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 <when value="b">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 <param name="b" value="1" label="Number of base pairs" type="integer" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 <when value="lr">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 <param name="l" type="integer" value="0" label="The number of base pairs to subtract from the start coordinate" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 <param name="r" type="integer" value="0" label="The number of base pairs to add to the end coordinate" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 </conditional>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <xml name="print_header">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 <param name="header" type="boolean" checked="False" truevalue="-header" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
73 label="Print the header from the A file prior to results" help="(-header)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
74 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
75 <!-- TODO this is currently not used, but we should make use of it -->
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
76 <xml name="genome_validator">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
77 <validator type="unspecified_build" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
78 <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey" metadata_column="1" message="Sequences are not currently available for the specified build." />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
79 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
80
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
81 <!-- ToDo column_picker -->
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
82 <xml name="choose_columns">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
83 <param name="cols" type="text" value=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
84 label="Specify the column(s) that should be summarized"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
85 help="comma separated (-c)">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
86 <sanitizer invalid_char="">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
87 <valid initial="string.digits"><add value=","/></valid>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
88 </sanitizer>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
89 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
90 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
91
15
ce2f9b4e4e7c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0d7fcf576fd797327af90538b216473ef13daa41
iuc
parents: 14
diff changeset
92 <xml name="choose_column">
ce2f9b4e4e7c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0d7fcf576fd797327af90538b216473ef13daa41
iuc
parents: 14
diff changeset
93 <param name="col" type="data_column" data_ref="inputA" label="Specify the column(s) that should be summarized" help="(-c)" />
ce2f9b4e4e7c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0d7fcf576fd797327af90538b216473ef13daa41
iuc
parents: 14
diff changeset
94 </xml>
ce2f9b4e4e7c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0d7fcf576fd797327af90538b216473ef13daa41
iuc
parents: 14
diff changeset
95
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
96 <token name="@C_AND_O_ARGUMENT@">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
97 #set $col = list()
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
98 #set $op = list()
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
99 #for $item in $c_and_o_argument_repeat:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
100 #silent $col.append( str($item.col) )
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
101 #silent $op.append( str($item.operation) )
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
102 #end for
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
103 #if $col:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
104 -c #echo ','.join($col)#
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
105 -o #echo ','.join($op)#
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
106 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
107 </token>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
108
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
109 <xml name="c_and_o_argument">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
110 <repeat name="c_and_o_argument_repeat" title="Applying operations to columns from merged intervals" min="0">
15
ce2f9b4e4e7c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0d7fcf576fd797327af90538b216473ef13daa41
iuc
parents: 14
diff changeset
111 <expand macro="choose_column" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
112 <expand macro="choose_operations">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
113 <expand macro="math_options" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
114 <expand macro="additional_math_options" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
115 </expand>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
116 </repeat>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
117 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
118
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
119
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
120 <xml name="choose_operations">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
121 <param name="operation" type="select" label="Specify the operation">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
122 <yield />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
123 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
124 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
125
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
126 <xml name="math_options">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
127 <option value="sum" selected="True">Sum - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
128 <option value="min">Min - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
129 <option value="max">Max - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
130 <option value="absmin">AbsMin - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
131 <option value="absmax">AbsMax - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
132 <option value="mean">Mean - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
133 <option value="median">Median - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
134 <option value="mode">Mode - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
135 <option value="antimode">Antimode - numeric only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
136 <option value="collapse">collapse (i.e., print a comma separated list) - numeric or text</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
137 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
138 <xml name="additional_math_options">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
139 <option value="count">Count - numeric or text</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
140 <option value="count_disctinct">Count Distinct - numeric or text</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
141 <option value="distinct">distinct (i.e., print a comma separated list) - numeric or text</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
142 <option value="concat">concat (i.e., print a comma separated list) - numeric or text</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
143 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
144 <token name="@REFERENCES@">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
145 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
146 ------
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
147
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
148 This tool is part of the `bedtools package`_ from the `Quinlan laboratory`_.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
149
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
150 .. _bedtools package: https://github.com/arq5x/bedtools2
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
151 .. _Quinlan laboratory: http://cphg.virginia.edu/quinlan/
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
152
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
153
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
154 **Citation**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
155
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
156 If you use this tool in Galaxy, please cite:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
157
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
158 Bjoern A. Gruening (2014), `Galaxy wrapper <https://github.com/bgruening/galaxytools>`_
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
159 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
160 </token>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
161 <xml name="citations">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
162 <citations>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
163 <citation type="doi">10.1093/bioinformatics/btq033</citation>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
164 <yield />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
165 </citations>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
166 </xml>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
167 </macros>