annotate breakdancer.xml @ 11:a8f3dba37a92 draft

Uploaded
author jeremie
date Wed, 02 Jul 2014 10:00:43 -0400
parents 44d381ebe8a5
children c220f4acef3f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
1 <tool id="breakdancer" name="breakdancer" version="1.4.4">
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
2 <requirements>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
3 <requirement type="package" version="1.4.4">breakdancer</requirement>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
4 </requirements>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
5
11
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
6 <description>detection of structural variants</description>
9
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
7
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
8 <parallelism method="basic"></parallelism>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
9
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
10 <command interpreter="python">
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
11 breakdancer.py
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
12 <!-- required -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
13 -i1 $inputBamFile
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
14 -o1 $outputRawFile
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
15 <!-- optional -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
16 -o2 $outputVcfFile
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
17 -o $chromosome
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
18 -s $minLength
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
19 -c $cutoff
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
20 -m $maxSvSize
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
21 -q $minMapQuality
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
22 -r $minReadDepth
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
23 -x $maxHaploidCov
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
24 -b $bufferSize
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
25 #if $onlyTrans:
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
26 -t
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
27 #end if
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
28 -d $prefix
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
29 #if $bedFormat:
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
30 -g
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
31 #end if
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
32 <!-- -l
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
33 -a
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
34 -h
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
35 -y -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
36 <!-- parser.add_argument('-l', dest='matePair', required=False, help='analyze Illumina long insert (mate-pair) library')
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
37 # parser.add_argument('-a', dest='sortByLibrary', action='store_true', help='print out copy number and support reads per library rather than per bam', default=False)
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
38 # parser.add_argument('-h', dest='', action='store_true', help='print out Allele Frequency column', default=False)
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
39 parser.add_argument('-y', dest='scoreFilter', type=int, required=False, help='output score filter', default=30) -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
40
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
41 </command>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
42
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
43 <inputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
44 <param name="inputBamFile" format="bam" type="data" label="input bam file" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
45 <!-- optional -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
46 <param name="chromosome" type="text" label="operate on a single chromosome" value="" />
11
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
47 <param name="minLength" type="integer" label="minimum length of a region" value="7" />
9
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
48 <param name="cutoff" type="integer" label="cutoff in unit of standard deviation" value="3" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
49 <param name="maxSvSize" type="integer" label="maximum SV size" value="1000000000" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
50 <param name="minMapQuality" type="integer" label="minimum alternative mapping quality" value="35" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
51 <param name="minReadDepth" type="integer" label="minimum number of read pairs required to establish a connection" value="2" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
52 <param name="maxHaploidCov" type="integer" label="maximum threshold of haploid sequence coverage for regions to be ignored" value="1000" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
53 <param name="bufferSize" type="integer" label="buffer size for building connection" value="100" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
54 <param name="onlyTrans" type="boolean" label="only detect transchromosomal rearrangement" checked="False" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
55 <param name="bufferSize" type="text" label="prefix of fastq files that SV supporting reads will be saved by library" value="" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
56 <param name="bedFormat" type="boolean" label="dump SVs and supporting reads in BED format for GBrowse" checked="False" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
57 </inputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
58
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
59 <outputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
60 <data name="outputRawFile" format="tabular" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
61 <data name="outputVcfFile" format="vcf" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
62 </outputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
63
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
64 <help>
11
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
65 BreakDancer, released under GPLv3, is a Cpp package that provides genome-wide detection of structural variants from next generation paired-end sequencing reads. It includes two complementary programs.
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
66 BreakDancerMax predicts five types of structural variants: insertions, deletions, inversions, inter- and intra-chromosomal translocations from next-generation short paired-end sequencing reads using read pairs that are mapped with unexpected separation distances or orientation.
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
67 BreakDancerMini focuses on detecting small indels (usually between 10bp and 100bp) using normally mapped read pairs.
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
68 Please read our paper for detailed algorithmic description. http://www.nature.com/nmeth/journal/v6/n9/abs/nmeth.1363.html
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
69
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
70 The input is a set of map files produced by a front-end aligner such as MAQ, BWA, NovoAlign and Bfast
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
71
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
72 The output format
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
73 ----------------------
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
74 BreakDancer's output file consists of the following columns:
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
75
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
76 1. Chromosome 1
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
77 2. Position 1
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
78 3. Orientation 1
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
79 4. Chromosome 2
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
80 5. Position 2
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
81 6. Orientation 2
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
82 7. Type of a SV
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
83 8. Size of a SV
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
84 9. Confidence Score
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
85 10. Total number of supporting read pairs
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
86 11. Total number of supporting read pairs from each map file
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
87 12. Estimated allele frequency
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
88 13. Software version
a8f3dba37a92 Uploaded
jeremie
parents: 9
diff changeset
89 14. The run parameters
9
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
90 </help>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
91 </tool>