annotate flankBed.xml @ 1:82aac94b06c3 draft

Uploaded
author iuc
date Thu, 08 Jan 2015 14:25:51 -0500
parents
children 607c0576c6ab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_flankbed" name="FlankBed" version="@WRAPPER_VERSION@.0">
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
2 <description></description>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
3 <macros>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
5 </macros>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
8 <command>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
10 flankBed
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
11 $pct
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
12 $strand
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
13 -g $genome
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
14 -i $input
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
15
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
16 #if $addition.addition_select == 'b':
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
17 -b $addition.b
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
18 #else:
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
19 -l $addition.l
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
20 -r $addition.r
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
21 #end if
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
22 > $output
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
23 ]]>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
24 </command>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
25 <inputs>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
26 <param format="bed,vcf,gff,gff3" name="input" type="data" label="BED/VCF/GFF file"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
27 <expand macro="genome" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
28 <param name="pct" type="boolean" checked="false" truevalue="-pct" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
29 label="Define -l and -r as a fraction of the feature’s length"
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
30 help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
31 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
32 label="Define -l and -r based on strand"
82aac94b06c3 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" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
34 <expand macro="addition" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
35 </inputs>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
36 <outputs>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
37 <data metadata_source="input" format_source="input" name="output" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
38 </outputs>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
39 <tests>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
40 <test>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
41 <param name="input" value="a.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
42 <param name="genome" value="mm9_chr1.len"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
43 <param name="addition_select" value="b"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
44 <param name="b" value="5"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
45 <output name="output" file="flankBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
46 </test>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
47 <test>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
48 <param name="input" value="a.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
49 <param name="genome" value="mm9_chr1.len"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
50 <param name="addition_select" value="lr"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
51 <param name="l" value="2"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
52 <param name="r" value="3"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
53 <output name="output" file="flankBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
54 </test>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
55 </tests>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
56 <help>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
57 <![CDATA[
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
58 **What it does**
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
59
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
60 bedtools flank will optionally create flanking intervals whose size is user-specified fraction of the original interval.
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
61
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
62 .. image:: $PATH_TO_IMAGES/flank-glyph.png
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
63
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
64 .. class:: warningmark
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
65
82aac94b06c3 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.
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
67
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
68 @REFERENCES@
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
69 ]]>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
70 </help>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
71 <expand macro="citations" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
72 </tool>