annotate macros.xml @ 3:2cd7e321d259 draft

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