annotate shuffleBed.xml @ 4:315929597efb draft

Uploaded
author iuc
date Wed, 07 Jan 2015 12:45:05 -0500
parents 7511823bdea1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_shufflebed" name="ShuffleBed" version="@WRAPPER_VERSION@.0">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
2 <description></description>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
3 <macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
5 </macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
8 <command>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
9 <![CDATA[
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
10 bedtools shuffle
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
11 -g $genome
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
12 -i $inputA
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
13 $bedpe
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
14 #if str($seed.seed_choose) == "True":
315929597efb Uploaded
iuc
parents: 1
diff changeset
15 -seed $seed.seed
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
16 #end if
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
17 #if str($add_bed.add_bed_select) == "not_be":
315929597efb Uploaded
iuc
parents: 1
diff changeset
18 -excl $add_bed_select.excl
315929597efb Uploaded
iuc
parents: 1
diff changeset
19 -f $add_bed_select.overlap
315929597efb Uploaded
iuc
parents: 1
diff changeset
20 #elif str($add_bed.add_bed_select) == "be":
315929597efb Uploaded
iuc
parents: 1
diff changeset
21 -incl $add_bed_select.incl
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
22 #end if
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
23 $chrom
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
24 $chromfirst
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
25 $no_overlap
315929597efb Uploaded
iuc
parents: 1
diff changeset
26 $allow_beyond
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
27 -maxTries $maxtries
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
28 > $output
315929597efb Uploaded
iuc
parents: 1
diff changeset
29 ]]>
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
30 </command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
31 <inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
32 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
33 <param name="bedpe" type="boolean" label="The file is in BEDPE format" selected="False" truevalue="-bedpe" falsevalue="" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
34 <expand macro="genome" />
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
35 <param name="chrom" type="boolean" selected="False" truevalue="-chrom" falsevalue=""
315929597efb Uploaded
iuc
parents: 1
diff changeset
36 label="Keep features in the input file on the same chromosome"
315929597efb Uploaded
iuc
parents: 1
diff changeset
37 help="Solely permute their location on the chromosome. By default, both the chromosome and position are randomly chosen. (-chrom)" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
38 <expand macro="seed" />
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
39 <conditional name="add_bed">
315929597efb Uploaded
iuc
parents: 1
diff changeset
40 <param name="add_bed_select" type="select" label="Choose an additional BED file">
315929597efb Uploaded
iuc
parents: 1
diff changeset
41 <option value="no" selected="True">No additional BED file</option>
315929597efb Uploaded
iuc
parents: 1
diff changeset
42 <option value="not_be">Coordinates in which features from -i should not be placed?</option>
315929597efb Uploaded
iuc
parents: 1
diff changeset
43 <option value="be">coordinates in which features from -i should be placed?</option>
315929597efb Uploaded
iuc
parents: 1
diff changeset
44 </param>
315929597efb Uploaded
iuc
parents: 1
diff changeset
45 <when value="not_be">
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
46 <param name="excl" type="data" format="bed" label="Choose File" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
47 <expand macro="overlap" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
48 </when>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
49 <when value="be">
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
50 <param name="incl" type="data" format="bed" label="Choose File" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
51 </when>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
52 </conditional>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
53 <param name="chromfirst" type="boolean" selected="False" truevalue="-chromFirst" falsevalue=""
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
54 label="Choose chromosome first"
315929597efb Uploaded
iuc
parents: 1
diff changeset
55 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. (-chromFirst)" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
56 <param name="maxtries" type="integer" value="1000"
315929597efb Uploaded
iuc
parents: 1
diff changeset
57 label="Max. number of attempts to find a home for a shuffled interval in the presence of -incl or -excl" help="(-maxTries)" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
58 <param name="no_overlap" type="boolean" selected="False" truevalue="-noOverlapping" falsevalue=""
315929597efb Uploaded
iuc
parents: 1
diff changeset
59 label="Don’t allow shuffled intervals to overlap" help="(-noOverlapping)" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
60 <param name="allow_beyond" type="boolean" selected="False" truevalue="-allowBeyondChromEnd" falsevalue=""
315929597efb Uploaded
iuc
parents: 1
diff changeset
61 label="Allow the original the length of the original records to extebd beyond the length of the chromosome" help="(-allowBeyondChromEnd)" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
62 </inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
63 <outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
64 <data format="bed" name="output" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
65 </outputs>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
66 <tests>
315929597efb Uploaded
iuc
parents: 1
diff changeset
67 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
68 <param name="inputA" value="shuffleBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
69 <param name="genome" value="shuffleBed.len" ftype="tabular" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
70 <param name="chrom" value="" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
71 <param name="seed_choose" value="True" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
72 <param name="seed" value="1" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
73 <output name="output" file="shuffleBed_result1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
74 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
75 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
76 <param name="inputA" value="shuffleBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
77 <param name="genome" value="shuffleBed.len" ftype="tabular" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
78 <param name="chrom" value="True" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
79 <param name="seed_choose" value="True" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
80 <param name="seed" value="1" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
81 <output name="output" file="shuffleBed_result2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
82 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
83 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
84 <param name="inputA" value="shuffleBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
85 <param name="genome" value="shuffleBed.len" ftype="tabular" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
86 <param name="excl" value="shuffleBed2.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
87 <param name="seed_choose" value="True" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
88 <param name="seed" value="1" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
89 <output name="output" file="shuffleBed_result3.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
90 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
91 <test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
92 <param name="inputA" value="shuffleBed1.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
93 <param name="genome" value="shuffleBed.len" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
94 <param name="allow_beyond" value="True" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
95 <param name="seed_choose" value="True" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
96 <param name="seed" value="1" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
97 <output name="output" file="shuffleBed_result4.bed" ftype="bed" />
315929597efb Uploaded
iuc
parents: 1
diff changeset
98 </test>
315929597efb Uploaded
iuc
parents: 1
diff changeset
99 </tests>
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
100 <help>
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
101 <![CDATA[
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
102 **What it does**
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
103
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
104 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” BED/GFF/VCF 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.
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
105
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
106 .. image:: $PATH_TO_IMAGES/shuffle-glyph.png
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
107
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
108 @REFERENCES@
4
315929597efb Uploaded
iuc
parents: 1
diff changeset
109 ]]>
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
110 </help>
1
7511823bdea1 Uploaded
iuc
parents: 0
diff changeset
111 <expand macro="citations" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
112 </tool>