annotate shuffleBed.xml @ 0:b8348686a0b9 draft

Imported from capsule None
author iuc
date Tue, 04 Nov 2014 01:45:04 -0500
parents
children 82aac94b06c3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="bedtools_shufflebed" name="ShuffleBed" version="@WRAPPER_VERSION@.0">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
2 <description></description>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
9 bedtools shuffle
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 -g $genome
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 -i $inputA
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 $bedpe
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 #if $seed.choose:
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
14 -seed $seed.seed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
16 #if $excl.choose:
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 -excl $excl.excl
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 -f $overlap
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
20 #if $incl.choose:
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 -incl $incl.incl
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 $chrom
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 $chromfirst
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 $nooverlap
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 $allowBeyond
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 -maxTries $maxtries
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 &gt; $output
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <param name="bedpe" type="boolean" label="The file is in BEDPE format" selected="False" truevalue="-bedpe" falsevalue="" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <expand macro="genome" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 <param name="chrom" type="boolean" label="Keep features in the input file on the same chromosome. Solely permute their location on the chromosome. By default, both the chromosome and position are randomly chosen" selected="False" truevalue="-chrom" falsevalue="" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 <expand macro="seed" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 <conditional name="excl">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
37 <param name="choose" type="boolean" label="Choose a BED file of coordinates in which features from -i should not be placed?" selected="False" truevalue="True" falsevalue="False" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 <when value="True">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 <param name="excl" type="data" format="bed" label="Choose File" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40 <expand macro="overlap" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 </when>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 </conditional>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
43 <conditional name="incl">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44 <param name="choose" type="boolean" label="Choose a BED file of coordinates in which features from -i should be placed?" selected="False" truevalue="True" falsevalue="False" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
45 <when value="True">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
46 <param name="incl" type="data" format="bed" label="Choose File" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
47 </when>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
48 </conditional>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
49
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
50 <param name="chromfirst" type="boolean" selected="False" truevalue="-chromFirst" falsevalue=""
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
51 label="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" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
52 <param name="maxtries" type="integer" value="1000" label="Max. number of attempts to find a home for a shuffled interval in the presence of -incl or -excl" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
53 <param name="nooverlap" type="boolean" selected="False" truevalue="-noOverlapping" falsevalue="" label="Don’t allow shuffled intervals to overlap" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
54 <param name="allowBeyond" type="boolean" selected="False" truevalue="-allowBeyondChromEnd" falsevalue="" label="Allow the original the length of the original records to extebd beyond the length of the chromosome." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
55 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
56 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
57 <data format="bed" name="output" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58 </outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59 <help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
60
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
61 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
62
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
64 .. image:: $PATH_TO_IMAGES/shuffle-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
65 @REFERENCES@
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
66 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
67 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
68 </tool>