annotate slopBed.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 0d3aa592ce27
children a2d4c30ba2f9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_slopbed" name="SlopBed" version="@WRAPPER_VERSION@.0">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
2 <description></description>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
10 bedtools slop
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
11 $pct
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
12 $strand
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
13 -g $genome
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
14 -i $inputA
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 #if $addition.addition_select == 'b':
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 -b $addition.b
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 #else:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 -l $addition.l
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 -r $addition.r
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 $header
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 > $output
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 <expand macro="genome" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 <param name="pct" type="boolean" checked="false" truevalue="-pct" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 label="Define -l and -r as a fraction of the feature’s length"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 label="Define -l and -r based on strand"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 help="If used, -l 500 for a negative-stranded feature, it will add 500 bp to the end coordinate" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <expand macro="addition" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <expand macro="print_header" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <data format="bed" name="output"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <param name="inputA" value="a.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <param name="genome" value="mm9_chr1.len" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 <param name="addition_select" value="b" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 <param name="b" value="5" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 <output name="output" file="slopBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 <param name="inputA" value="a.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 <param name="genome" value="mm9_chr1.len" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 <param name="addition_select" value="lr" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 <param name="l" value="2" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 <param name="r" value="3" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 <output name="output" file="slopBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 bedtools slop will increase the size of each feature in a feature file by a user-defined number of bases. While something like this could be done with an awk '{OFS="\t" print $1,$2-&lt;slop>,$3+&lt;slop>}', bedtools slop will restrict the resizing to the size of the chromosome (i.e. no start &lt; 0 and no end > chromosome size).
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 .. image:: $PATH_TO_IMAGES/slop-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 .. class:: warningmark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 In order to prevent the extension of intervals beyond chromosome boundaries, bedtools slop requires a genome file defining the length of each chromosome or contig.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 </tool>