annotate shuffleBed.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
61
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
1 <tool id="bedtools_shufflebed" name="bedtools ShuffleBed" version="@TOOL_VERSION@+galaxy1" profile="@PROFILE@">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 13
diff changeset
2 <description>randomly redistrubute intervals in a genome</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 shuffle
61
9f6bd4c9479f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit db0b91a784ca0c216345bc488d7d488babf1b53f"
iuc
parents: 59
diff changeset
11 @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
12 -i '$inputA'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 $bedpe
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
14 #if str($seed) != "":
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
15 -seed $seed
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 #if str($add_bed.add_bed_select) == "not_be":
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
18 -excl $add_bed.excl
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
19 #if str($add_bed.overlap)
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
20 -f $add_bed.overlap
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
21 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
22 #elif str($add_bed.add_bed_select) == "be":
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
23 -incl $add_bed.incl
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
24 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
25 $chrom
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
26 $chromfirst
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
27 $no_overlap
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
28 $allow_beyond
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
29 -maxTries $maxtries
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
30 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
31 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
33 <param name="inputA" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
34 <param argument="-bedpe" type="boolean" truevalue="-bedpe" falsevalue="" checked="false" label="The file is in BEDPE format" />
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
35 <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
36 <param argument="-chrom" type="boolean" truevalue="-chrom" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 label="Keep features in the input file on the same chromosome"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
38 help="Solely permute their location on the chromosome. By default, both the chromosome and position are randomly chosen." />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <expand macro="seed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <conditional name="add_bed">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <param name="add_bed_select" type="select" label="Choose an additional BED file">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
42 <option value="no" selected="true">No additional BED file</option>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <option value="not_be">Coordinates in which features from -i should not be placed?</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 <option value="be">coordinates in which features from -i should be placed?</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 </param>
13
bdb4509d9482 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e8e971905f5fce11a99d51b1399af45288389d76
iuc
parents: 8
diff changeset
46 <when value="no" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <when value="not_be">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
48 <param argument="-excl" type="data" format="bed" label="Choose File" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
49 <expand macro="fraction" name="overlap" argument="-f" label="Maximum overlap (as a fraction of the -i feature) with an -excl feature that is tolerated before searching for a new, randomized locus" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 <when value="be">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
52 <param argument="-incl" type="data" format="bed" label="Choose File" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 </conditional>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
55 <param name="chromfirst" argument="-chromFirst" type="boolean" truevalue="-chromFirst" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 label="Choose chromosome first"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
57 help="Instead of choosing a position randomly among the entire genome (the default), first choose a chrom randomly, and then choose a random start coordinate on that chrom. This leads to features being ~uniformly distributed among the chroms, as opposed to features being distribute as a function of chrom size." />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
58 <param name="maxtries" argument="-maxTries" type="integer" value="1000"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
59 label="Max. number of attempts to find a home for a shuffled interval in the presence of -incl or -excl" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
60 <param name="no_overlap" argument="-noOverlapping" type="boolean" truevalue="-noOverlapping" falsevalue="" checked="false"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
61 label="Don’t allow shuffled intervals to overlap" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
62 <param name="allow_beyond" argument="-allowBeyondChromEnd" type="boolean" truevalue="-allowBeyondChromEnd" falsevalue="" checked="false"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
63 label="Allow the original the length of the original records to extebd beyond the length of the chromosome" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
66 <data name="output" format="bed" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 <param name="inputA" value="shuffleBed1.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
71 <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
72 <param name="genome_file_opts|genome" value="shuffleBed.len" ftype="tabular" />
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 61
diff changeset
73 <param name="chrom" value="false" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
74 <param name="seed" value="1" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
75 <output name="output" file="shuffleBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
76 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
77 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
78 <param name="inputA" value="shuffleBed1.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
79 <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
80 <param name="genome_file_opts|genome" value="shuffleBed.len" ftype="tabular" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
81 <param name="chrom" value="True" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
82 <param name="seed" value="1" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
83 <output name="output" file="shuffleBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
84 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
85 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
86 <param name="inputA" value="shuffleBed1.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
87 <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
88 <param name="genome_file_opts|genome" value="shuffleBed.len" ftype="tabular" />
54
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
89 <conditional name="add_bed">
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
90 <param name="add_bed_select" value="not_be"/>
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
91 <param name="excl" value="shuffleBed2.bed" ftype="bed" />
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
92 </conditional>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
93 <param name="seed" value="1" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
94 <output name="output" file="shuffleBed_result3.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
95 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
96 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
97 <param name="inputA" value="shuffleBed1.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
98 <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
99 <param name="genome_file_opts|genome" value="shuffleBed.len" ftype="bed" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
100 <param name="allow_beyond" value="True" />
54
b06c53665eb6 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 8e072170dd8f7b68fabbf29b1b0d7d14974b8b22"
iuc
parents: 50
diff changeset
101 <param name="seed" value="3" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
102 <output name="output" file="shuffleBed_result4.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
103 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
104 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
105 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
106 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
107
42
d279800f4ff9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b75b9e79cf3186a22dc2e1e9d27c1a080b891b59
iuc
parents: 35
diff changeset
108 bedtools shuffle will randomly permute the genomic locations of a feature file among a genome defined in a genome file. One can also provide an “exclusions” @STD_BEDTOOLS_INPUT_LABEL@ file that lists regions where you do not want the permuted features to be placed. For example, one might want to prevent features from being placed in known genome gaps. shuffle is useful as a null basis against which to test the significance of associations of one feature with another.
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
109
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
110 .. image:: $PATH_TO_IMAGES/shuffle-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
111
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
112 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
113 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
114 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
115 </tool>