annotate flankBed.xml @ 39:3e38c9b3214f draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
author iuc
date Wed, 01 Sep 2021 11:04:15 +0000
parents dde39ba9c031
children 7ab85ac5f64b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39
3e38c9b3214f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 34
diff changeset
1 <tool id="bedtools_flankbed" name="bedtools FlankBed" version="@TOOL_VERSION@" 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>create new intervals from the flanks of existing intervals</description>
39
3e38c9b3214f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 34
diff changeset
3 <expand macro="bio_tools" />
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
4 <macros>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
5 <import>macros.xml</import>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
6 </macros>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
82aac94b06c3 Uploaded
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 flankBed
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
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
13 -g @GENOME_FILE@
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
14 -i '$input'
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
15
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
16 #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
17 -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
18 #else:
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
19 -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
20 -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
21 #end if
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>
1
82aac94b06c3 Uploaded
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="input" 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:
diff changeset
28 label="Define -l and -r as a fraction of the feature’s length"
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
29 help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
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:
diff changeset
31 label="Define -l and -r based on strand"
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
32 help="For example, if used, -l 500 for a negative-stranded feature, it will add 500 bp to the end coordinate" />
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
33 <expand macro="addition" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
34 </inputs>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
35 <outputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
36 <data name="output" format_source="input" metadata_source="input" />
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
37 </outputs>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
38 <tests>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
39 <test>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
40 <param name="input" 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
41 <param name="genome_file_opts_selector" value="hist" />
1
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" />
17
44867b59dbf2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
iuc
parents: 11
diff changeset
49 <param name="genome_file_opts_selector" value="hist" />
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
50 <param name="genome" value="mm9_chr1.len"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
51 <param name="addition_select" value="lr"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
52 <param name="l" value="2"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
53 <param name="r" value="3"/>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
54 <output name="output" file="flankBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
55 </test>
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
56 </tests>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
57 <help><![CDATA[
1
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
30
db1841942d2b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b67e138b17f7e8cb34f59bed0925f691ec9740f3
iuc
parents: 26
diff changeset
66 In order to prevent creating intervals that violate chromosome boundaries, bedTools flank requires a bedTool genome file defining the length of each chromosome or contig. . This should be a two column tabular file with the chromosome name in the first column and the END coordinate of the chromosome in the second column.
db1841942d2b planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b67e138b17f7e8cb34f59bed0925f691ec9740f3
iuc
parents: 26
diff changeset
67
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
68 If you need this data for any genome that is at UCSC (http://genome.ucsc.edu), it can be extracted from the Table Browser with the "Get Data: UCSC Main" tool. Set "group" to "All Tables", "table" to "chromInfo", and "output format" to "all fields from selected table".
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
69
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
70 @REFERENCES@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 32
diff changeset
71 ]]></help>
1
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
72 <expand macro="citations" />
82aac94b06c3 Uploaded
iuc
parents:
diff changeset
73 </tool>