annotate macros.xml @ 0:676394f0f50a draft default tip

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