annotate slopBed.xml @ 64:f6c88d2e9ae5 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
author iuc
date Fri, 21 Feb 2025 21:38:34 +0000
parents 9f6bd4c9479f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
1 <tool id="bedtools_slopbed" name="bedtools SlopBed" version="@TOOL_VERSION@+galaxy0" profile="@PROFILE@">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 8
diff changeset
2 <description>adjust the size of intervals</description>
8
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>
59
539958feb49c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 500a03281ea704abc7a16d9af63d67dbdcc5cd0b"
iuc
parents: 57
diff changeset
6 <expand macro="bio_tools" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <expand macro="stdio" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
9 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 bedtools slop
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 $pct
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 $strand
61
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
13 @GENOME_FILE@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 -i '$inputA'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
15 #if $addition.addition_select == 'b':
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 -b $addition.b
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 #else:
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
18 -l $addition.l
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
19 -r $addition.r
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
20 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
21 $header
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
22 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
23 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
25 <param name="inputA" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file" />
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
26 <expand macro="input_conditional_genome_file" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
27 <param argument="-pct" type="boolean" truevalue="-pct" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 label="Define -l and -r as a fraction of the feature’s length"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
30 <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 label="Define -l and -r based on strand"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 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
33 <expand macro="addition" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <expand macro="print_header" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
37 <data name="output" format="bed" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <param name="inputA" value="a.bed" ftype="bed" />
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
42 <param name="genome_file_opts|genome_file_opts_selector" value="hist" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
43 <param name="genome_file_opts|genome" value="mm9_chr1.len" ftype="bed" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
44 <param name="addition|addition_select" value="b" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
45 <param name="addition|b" value="5" />
8
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" />
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
50 <param name="genome_file_opts|genome_file_opts_selector" value="hist" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
51 <param name="genome_file_opts|genome" value="mm9_chr1.len" ftype="bed" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
52 <param name="addition|addition_select" value="lr" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
53 <param name="addition|l" value="2" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
54 <param name="addition|r" value="3" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 <output name="output" file="slopBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
58 <help><![CDATA[
8
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.
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
68
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
70 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 </tool>