annotate flankBed.xml @ 17:a2d4c30ba2f9 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
author iuc
date Sun, 21 Jun 2015 22:49:46 -0400
parents 315929597efb
children 5efc48568d8d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
315929597efb Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_flankbed" name="FlankBed" version="@WRAPPER_VERSION@.0">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 4
diff changeset
2 <description>create new intervals from the flanks of existing intervals</description>
4
315929597efb Uploaded
iuc
parents:
diff changeset
3 <macros>
315929597efb Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
315929597efb Uploaded
iuc
parents:
diff changeset
5 </macros>
315929597efb Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
315929597efb Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
315929597efb Uploaded
iuc
parents:
diff changeset
8 <command>
315929597efb Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
315929597efb Uploaded
iuc
parents:
diff changeset
10 flankBed
315929597efb Uploaded
iuc
parents:
diff changeset
11 $pct
315929597efb Uploaded
iuc
parents:
diff changeset
12 $strand
315929597efb Uploaded
iuc
parents:
diff changeset
13 -g $genome
315929597efb Uploaded
iuc
parents:
diff changeset
14 -i $input
315929597efb Uploaded
iuc
parents:
diff changeset
15
315929597efb Uploaded
iuc
parents:
diff changeset
16 #if $addition.addition_select == 'b':
315929597efb Uploaded
iuc
parents:
diff changeset
17 -b $addition.b
315929597efb Uploaded
iuc
parents:
diff changeset
18 #else:
315929597efb Uploaded
iuc
parents:
diff changeset
19 -l $addition.l
315929597efb Uploaded
iuc
parents:
diff changeset
20 -r $addition.r
315929597efb Uploaded
iuc
parents:
diff changeset
21 #end if
315929597efb Uploaded
iuc
parents:
diff changeset
22 > $output
315929597efb Uploaded
iuc
parents:
diff changeset
23 ]]>
315929597efb Uploaded
iuc
parents:
diff changeset
24 </command>
315929597efb Uploaded
iuc
parents:
diff changeset
25 <inputs>
315929597efb Uploaded
iuc
parents:
diff changeset
26 <param format="bed,vcf,gff,gff3" name="input" type="data" label="BED/VCF/GFF file"/>
315929597efb Uploaded
iuc
parents:
diff changeset
27 <expand macro="genome" />
315929597efb Uploaded
iuc
parents:
diff changeset
28 <param name="pct" type="boolean" checked="false" truevalue="-pct" falsevalue=""
315929597efb Uploaded
iuc
parents:
diff changeset
29 label="Define -l and -r as a fraction of the feature’s length"
315929597efb Uploaded
iuc
parents:
diff changeset
30 help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
315929597efb Uploaded
iuc
parents:
diff changeset
31 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue=""
315929597efb Uploaded
iuc
parents:
diff changeset
32 label="Define -l and -r based on strand"
315929597efb Uploaded
iuc
parents:
diff changeset
33 help="For example. if used, -l 500 for a negative-stranded feature, it will add 500 bp to the end coordinate" />
315929597efb Uploaded
iuc
parents:
diff changeset
34 <expand macro="addition" />
315929597efb Uploaded
iuc
parents:
diff changeset
35 </inputs>
315929597efb Uploaded
iuc
parents:
diff changeset
36 <outputs>
315929597efb Uploaded
iuc
parents:
diff changeset
37 <data metadata_source="input" format_source="input" name="output" />
315929597efb Uploaded
iuc
parents:
diff changeset
38 </outputs>
315929597efb Uploaded
iuc
parents:
diff changeset
39 <tests>
315929597efb Uploaded
iuc
parents:
diff changeset
40 <test>
315929597efb Uploaded
iuc
parents:
diff changeset
41 <param name="input" value="a.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents:
diff changeset
42 <param name="genome" value="mm9_chr1.len"/>
315929597efb Uploaded
iuc
parents:
diff changeset
43 <param name="addition_select" value="b"/>
315929597efb Uploaded
iuc
parents:
diff changeset
44 <param name="b" value="5"/>
315929597efb Uploaded
iuc
parents:
diff changeset
45 <output name="output" file="flankBed_result1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents:
diff changeset
46 </test>
315929597efb Uploaded
iuc
parents:
diff changeset
47 <test>
315929597efb Uploaded
iuc
parents:
diff changeset
48 <param name="input" value="a.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents:
diff changeset
49 <param name="genome" value="mm9_chr1.len"/>
315929597efb Uploaded
iuc
parents:
diff changeset
50 <param name="addition_select" value="lr"/>
315929597efb Uploaded
iuc
parents:
diff changeset
51 <param name="l" value="2"/>
315929597efb Uploaded
iuc
parents:
diff changeset
52 <param name="r" value="3"/>
315929597efb Uploaded
iuc
parents:
diff changeset
53 <output name="output" file="flankBed_result2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents:
diff changeset
54 </test>
315929597efb Uploaded
iuc
parents:
diff changeset
55 </tests>
315929597efb Uploaded
iuc
parents:
diff changeset
56 <help>
315929597efb Uploaded
iuc
parents:
diff changeset
57 <![CDATA[
315929597efb Uploaded
iuc
parents:
diff changeset
58 **What it does**
315929597efb Uploaded
iuc
parents:
diff changeset
59
315929597efb Uploaded
iuc
parents:
diff changeset
60 bedtools flank will optionally create flanking intervals whose size is user-specified fraction of the original interval.
315929597efb Uploaded
iuc
parents:
diff changeset
61
315929597efb Uploaded
iuc
parents:
diff changeset
62 .. image:: $PATH_TO_IMAGES/flank-glyph.png
315929597efb Uploaded
iuc
parents:
diff changeset
63
315929597efb Uploaded
iuc
parents:
diff changeset
64 .. class:: warningmark
315929597efb Uploaded
iuc
parents:
diff changeset
65
315929597efb Uploaded
iuc
parents:
diff changeset
66 In order to prevent creating intervals that violate chromosome boundaries, bedtools flank requires a genome file defining the length of each chromosome or contig.
315929597efb Uploaded
iuc
parents:
diff changeset
67
315929597efb Uploaded
iuc
parents:
diff changeset
68 @REFERENCES@
315929597efb Uploaded
iuc
parents:
diff changeset
69 ]]>
315929597efb Uploaded
iuc
parents:
diff changeset
70 </help>
315929597efb Uploaded
iuc
parents:
diff changeset
71 <expand macro="citations" />
315929597efb Uploaded
iuc
parents:
diff changeset
72 </tool>