annotate macros.xml @ 4:315929597efb draft

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