annotate shuffleBed.xml @ 12:c782e0edc4f1 draft default tip

Uploaded
author bgruening
date Thu, 19 Jun 2014 10:12:00 -0400
parents e526617a6bb9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
1 <tool id="bedtools_shufflebed" name="ShuffleBed" version="@WRAPPER_VERSION@.0">
11
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
9 bedtools shuffle
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
10 -g $genome
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
11 -i $inputA
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
12 $bedpe
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
13 #if $seed.choose:
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
14 -seed $seed.seed
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
15 #end if
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
16 #if $excl.choose:
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
17 -excl $excl.excl
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
18 -f $overlap
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
19 #end if
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
20 #if $incl.choose:
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
21 -incl $incl.incl
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
22 #end if
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
23 $chrom
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
24 $chromfirst
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
25 $nooverlap
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
26 $allowBeyond
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
27 -maxTries $maxtries
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
28 &gt; $output
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
29 </command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
30 <inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
31 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
32 <param name="bedpe" type="boolean" label="The file is in BEDPE format" selected="False" truevalue="-bedpe" falsevalue="" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
33 <expand macro="genome" />
e526617a6bb9 Uploaded
bernhardlutz
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="" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
35 <expand macro="seed" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
36 <conditional name="excl">
e526617a6bb9 Uploaded
bernhardlutz
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" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
38 <when value="True">
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
39 <param name="excl" type="data" format="bed" label="Choose File" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
40 <expand macro="overlap" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
41 </when>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
42 </conditional>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
43 <conditional name="incl">
e526617a6bb9 Uploaded
bernhardlutz
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" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
45 <when value="True">
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
46 <param name="incl" type="data" format="bed" label="Choose File" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
47 </when>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
48 </conditional>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
49
12
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
50 <param name="chromfirst" type="boolean" selected="False" truevalue="-chromFirst" falsevalue=""
c782e0edc4f1 Uploaded
bgruening
parents: 11
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" />
11
e526617a6bb9 Uploaded
bernhardlutz
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" />
12
c782e0edc4f1 Uploaded
bgruening
parents: 11
diff changeset
53 <param name="nooverlap" type="boolean" selected="False" truevalue="-noOverlapping" falsevalue="" label="Don’t allow shuffled intervals to overlap" />
c782e0edc4f1 Uploaded
bgruening
parents: 11
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." />
11
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
55 </inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
56 <outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
57 <data format="bed" name="output" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
58 </outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
59 <help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
60
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
61 **What it does**
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
62
e526617a6bb9 Uploaded
bernhardlutz
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.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
64 .. image:: $PATH_TO_IMAGES/shuffle-glyph.png
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
65 @REFERENCES@
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
66 </help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
67 </tool>