annotate slopBed.xml @ 0:b8348686a0b9 draft

Imported from capsule None
author iuc
date Tue, 04 Nov 2014 01:45:04 -0500
parents
children 82aac94b06c3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="bedtools_slopbed" name="SlopBed" version="@WRAPPER_VERSION@.0">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
2 <description></description>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
9 bedtools slop
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 $pct
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 $strand
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 -g $genome
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 -i $inputA
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
14 #if $addition.addition_select == 'b':
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 -b $addition.b
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
16 #else:
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 -l $addition.l
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 -r $addition.r
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
20 $header
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 &gt; $output
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 <expand macro="genome" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 <param name="pct" type="boolean" checked="false" truevalue="-pct" falsevalue="" label="Define -l and -r as a fraction of the feature’s length" help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue="" label="Define -l and -r based on strand" help="For example. if used, -l 500 for a negative-stranded feature, it will add 500 bp to the end coordinate" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 <expand macro="addition" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 <param name="header" type="boolean" checked="false" truevalue="-header" falsevalue="" label="Print the header from the input file prior to results." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <data format="bed" name="output" label=""/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 </outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 <help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
37 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 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).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 .. image:: $PATH_TO_IMAGES/slop-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
43 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
45 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
46 @REFERENCES@
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
47 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
48 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
49 </tool>