annotate macros.xml @ 0:4fb5ea02b441 draft

Uploaded
author iuc
date Tue, 15 Jul 2014 14:42:23 -0400
parents
children 7511823bdea1
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>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
4 <requirement type="package" version="2.19.1">bedtools</requirement>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
5 </requirements>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
6 <version_command>bedtools --version</version_command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
7 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
8 <token name="@WRAPPER_VERSION@">2.19</token>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
9 <xml name="stdio">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
10 <stdio>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
11 <!-- Anything other than zero is an error -->
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
12 <exit_code range="1:" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
13 <exit_code range=":-1" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
14 <!-- In case the return code has not been set propery check stderr too -->
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
15 <regex match="Error:" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
16 <regex match="Exception:" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
17 </stdio>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
18 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
19
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
20 <xml name="overlap">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
21 <param name="overlap" type="float" value="0.000000001" label="Minimum overlap required as a fraction of A" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
22 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
23 <xml name="strand2">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
24 <param name="strand" type="select" label="Calculation based on strandedness?">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
25 <option value="" selected="True">Overlaps on either strand</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
26 <option value="-s">Only overlaps occurring on the **same** strand.</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
27 <option value="-S">Only overlaps occurring on the **opposite** strand.</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
28 </param>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
29 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
30 <xml name="seed">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
31 <conditional name="seed">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
32 <param name="choose" type="boolean" label="Choose Seed?" selected="False" truevalue="True" falsevalue="False" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
33 <when value="True">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
34 <param name="seed" type="integer" value="12345" label="Enter Seed" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
35 </when>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
36 </conditional>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
37 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
38 <xml name="split">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
39 <param name="split" type="boolean" checked="true" truevalue="-split" falsevalue=""
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
40 label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage."
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
41 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." />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
42 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
43 <xml name="genome">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
44 <param format="bed,vcf,gff,gff3" name="genome" type="data" label="Genome file" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
45 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
46 <xml name="addition">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
47 <conditional name="addition">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
48 <param name="addition_select" type="select" label="Choose what you want to do">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
49 <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
50 <option value="lr">Increase by Start Coordinate and End Coordinate</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
51 </param>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
52 <when value="b">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
53 <param name="b" label="Give Value" type="integer" value="0" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
54 </when>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
55 <when value="lr">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
56 <param name="l" label="The number of base pairs to subtract from the start coordinate" type="integer" value="0" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
57 <param name="r" label="The number of base pairs to add to the end coordinate" type="integer" value="0" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
58 </when>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
59 </conditional>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
60 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
61 <xml name="math_options">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
62 <option value="min">Min - numeric only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
63 <option value="max">Max - numeric only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
64 <option value="mean">Mean - numeric only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
65 <option value="median">Median - numeric only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
66 <option value="mode">Mode - numeric only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
67 <option value="antimode">Antimode - numeric only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
68 <option value="collapse">collapse (i.e., print a comma separated list) - numeric or text</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
69 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
70 <xml name="additional_math_options">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
71 <option value="count">Count - numeric or text</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
72 <option value="count_disctinct">Count Distinct - numeric or text</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
73 <option value="distinct">distinct (i.e., print a comma separated list) - numeric or text</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
74 <option value="concat">concat (i.e., print a comma separated list) - numeric or text</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
75 </xml>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
76 <token name="@REFERENCES@">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
77 ------
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
78
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
79 This tool is part of the `bedtools package`__ from the `Quinlan laboratory`__.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
80 If you use this tool, please cite `Quinlan AR, and Hall I.M. BEDTools: A flexible framework for comparing genomic features. Bioinformatics, 2010, 26, 6.`__
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
81
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
82 .. __: https://github.com/arq5x/bedtools2
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
83 .. __: http://cphg.virginia.edu/quinlan/
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
84 .. __: http://bioinformatics.oxfordjournals.org/content/26/6/841.short
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
85 .. __: http://bedtools.readthedocs.org/en/latest/content/bedtools-suite.html
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
86 </token>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
87 </macros>