annotate slopBed.xml @ 43:07e8b80f278c draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
author iuc
date Fri, 01 Apr 2022 19:02:51 +0000
parents 7ab85ac5f64b
children 64e2edfe7a2c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
43
07e8b80f278c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 41
diff changeset
1 <tool id="bedtools_slopbed" name="bedtools SlopBed" version="@TOOL_VERSION@+galaxy1" profile="@PROFILE@">
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
2 <description>adjust the size of intervals</description>
0
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>
41
7ab85ac5f64b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 500a03281ea704abc7a16d9af63d67dbdcc5cd0b"
iuc
parents: 39
diff changeset
6 <expand macro="bio_tools" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <expand macro="stdio" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
9 <command><![CDATA[
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
10 bedtools slop
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
11 $pct
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
12 $strand
43
07e8b80f278c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 41
diff changeset
13 @GENOME_FILE@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
14 -i '$inputA'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
15 #if $addition.addition_select == 'b':
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
16 -b $addition.b
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
17 #else:
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
18 -l $addition.l
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
19 -r $addition.r
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
20 #end if
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
21 $header
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
22 > '$output'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
23 ]]></command>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 <inputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
25 <param name="inputA" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file" />
17
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
26 <expand macro="input_conditional_genome_file" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
27 <param argument="-pct" type="boolean" truevalue="-pct" falsevalue="" checked="false"
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
28 label="Define -l and -r as a fraction of the feature’s length"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
29 help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
30 <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false"
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
31 label="Define -l and -r based on strand"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
32 help="If used, -l 500 for a negative-stranded feature, it will add 500 bp to the end coordinate" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <expand macro="addition" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
34 <expand macro="print_header" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 <outputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
37 <data name="output" format="bed" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
39 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
41 <param name="inputA" value="a.bed" ftype="bed" />
17
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
42 <param name="genome_file_opts_selector" value="hist" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 <param name="genome" value="mm9_chr1.len" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
44 <param name="addition_select" value="b" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
45 <param name="b" value="5" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
46 <output name="output" file="slopBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
47 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 <param name="inputA" value="a.bed" ftype="bed" />
17
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
50 <param name="genome_file_opts_selector" value="hist" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
51 <param name="genome" value="mm9_chr1.len" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 <param name="addition_select" value="lr" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
53 <param name="l" value="2" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
54 <param name="r" value="3" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
55 <output name="output" file="slopBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
56 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
57 </tests>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
58 <help><![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
60
b8348686a0b9 Imported from capsule None
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).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
62
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63 .. image:: $PATH_TO_IMAGES/slop-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
64
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
65 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
66
b8348686a0b9 Imported from capsule None
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.
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
68
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
69 @REFERENCES@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
70 ]]></help>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
71 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
72 </tool>