annotate flankBed.xml @ 50:df28283b3778 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
author iuc
date Mon, 29 Apr 2019 05:54:22 -0400
parents 2f457890d8c8
children 7a06bb42dbb1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
1 <tool id="bedtools_flankbed" name="bedtools FlankBed" version="@TOOL_VERSION@">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 4
diff changeset
2 <description>create new intervals from the flanks of existing intervals</description>
4
315929597efb Uploaded
iuc
parents:
diff changeset
3 <macros>
315929597efb Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
315929597efb Uploaded
iuc
parents:
diff changeset
5 </macros>
315929597efb Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
315929597efb Uploaded
iuc
parents:
diff changeset
7 <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
8 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
9 flankBed
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 $pct
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 $strand
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 -g @GENOME_FILE@
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 -i '$input'
4
315929597efb Uploaded
iuc
parents:
diff changeset
14
50
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 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
22 ]]></command>
4
315929597efb Uploaded
iuc
parents:
diff changeset
23 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
24 <param name="input" 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
25 <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
26 <param argument="-pct" type="boolean" truevalue="-pct" falsevalue="" checked="false"
4
315929597efb Uploaded
iuc
parents:
diff changeset
27 label="Define -l and -r as a fraction of the feature’s length"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
28 help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
29 <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false"
4
315929597efb Uploaded
iuc
parents:
diff changeset
30 label="Define -l and -r based on strand"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
31 help="For example, if used, -l 500 for a negative-stranded feature, it will add 500 bp to the end coordinate" />
4
315929597efb Uploaded
iuc
parents:
diff changeset
32 <expand macro="addition" />
315929597efb Uploaded
iuc
parents:
diff changeset
33 </inputs>
315929597efb Uploaded
iuc
parents:
diff changeset
34 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
35 <data name="output" format_source="input" metadata_source="input" />
4
315929597efb Uploaded
iuc
parents:
diff changeset
36 </outputs>
315929597efb Uploaded
iuc
parents:
diff changeset
37 <tests>
315929597efb Uploaded
iuc
parents:
diff changeset
38 <test>
315929597efb Uploaded
iuc
parents:
diff changeset
39 <param name="input" value="a.bed" ftype="bed" />
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
40 <param name="genome_file_opts_selector" value="hist" />
4
315929597efb Uploaded
iuc
parents:
diff changeset
41 <param name="genome" value="mm9_chr1.len"/>
315929597efb Uploaded
iuc
parents:
diff changeset
42 <param name="addition_select" value="b"/>
315929597efb Uploaded
iuc
parents:
diff changeset
43 <param name="b" value="5"/>
315929597efb Uploaded
iuc
parents:
diff changeset
44 <output name="output" file="flankBed_result1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents:
diff changeset
45 </test>
315929597efb Uploaded
iuc
parents:
diff changeset
46 <test>
315929597efb Uploaded
iuc
parents:
diff changeset
47 <param name="input" value="a.bed" ftype="bed" />
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
48 <param name="genome_file_opts_selector" value="hist" />
4
315929597efb Uploaded
iuc
parents:
diff changeset
49 <param name="genome" value="mm9_chr1.len"/>
315929597efb Uploaded
iuc
parents:
diff changeset
50 <param name="addition_select" value="lr"/>
315929597efb Uploaded
iuc
parents:
diff changeset
51 <param name="l" value="2"/>
315929597efb Uploaded
iuc
parents:
diff changeset
52 <param name="r" value="3"/>
315929597efb Uploaded
iuc
parents:
diff changeset
53 <output name="output" file="flankBed_result2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents:
diff changeset
54 </test>
315929597efb Uploaded
iuc
parents:
diff changeset
55 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
56 <help><![CDATA[
4
315929597efb Uploaded
iuc
parents:
diff changeset
57 **What it does**
315929597efb Uploaded
iuc
parents:
diff changeset
58
315929597efb Uploaded
iuc
parents:
diff changeset
59 bedtools flank will optionally create flanking intervals whose size is user-specified fraction of the original interval.
315929597efb Uploaded
iuc
parents:
diff changeset
60
315929597efb Uploaded
iuc
parents:
diff changeset
61 .. image:: $PATH_TO_IMAGES/flank-glyph.png
315929597efb Uploaded
iuc
parents:
diff changeset
62
315929597efb Uploaded
iuc
parents:
diff changeset
63 .. class:: warningmark
315929597efb Uploaded
iuc
parents:
diff changeset
64
46
01c7c0d32674 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b67e138b17f7e8cb34f59bed0925f691ec9740f3
iuc
parents: 42
diff changeset
65 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.
01c7c0d32674 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b67e138b17f7e8cb34f59bed0925f691ec9740f3
iuc
parents: 42
diff changeset
66
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
67 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".
4
315929597efb Uploaded
iuc
parents:
diff changeset
68
315929597efb 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>
4
315929597efb Uploaded
iuc
parents:
diff changeset
71 <expand macro="citations" />
315929597efb Uploaded
iuc
parents:
diff changeset
72 </tool>