annotate breakdancer.xml @ 9:44d381ebe8a5 draft

Uploaded
author jeremie
date Wed, 02 Jul 2014 09:46:26 -0400
parents
children a8f3dba37a92
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
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
6 <description>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
7 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. 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. BreakDancerMini focuses on detecting small indels (usually between 10bp and 100bp) using normally mapped read pairs. Please read our paper for detailed algorithmic description. http://www.nature.com/nmeth/journal/v6/n9/abs/nmeth.1363.html
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
8
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
9 The input is a set of map files produced by a front-end aligner such as MAQ, BWA, NovoAlign and Bfast
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
10
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
11 The output format
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
12 ----------------------
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
13 BreakDancer's output file consists of the following columns:
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
14
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
15 1. Chromosome 1
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
16 2. Position 1
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
17 3. Orientation 1
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
18 4. Chromosome 2
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
19 5. Position 2
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
20 6. Orientation 2
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
21 7. Type of a SV
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
22 8. Size of a SV
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
23 9. Confidence Score
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
24 10. Total number of supporting read pairs
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
25 11. Total number of supporting read pairs from each map file
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
26 12. Estimated allele frequency
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
27 13. Software version
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
28 14. The run parameters
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
29 </description>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
30
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
31 <parallelism method="basic"></parallelism>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
32
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
33 <command interpreter="python">
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
34 breakdancer.py
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
35 <!-- required -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
36 -i1 $inputBamFile
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
37 -o1 $outputRawFile
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
38 <!-- optional -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
39 -o2 $outputVcfFile
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
40 -o $chromosome
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
41 -s $minLength
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
42 -c $cutoff
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
43 -m $maxSvSize
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
44 -q $minMapQuality
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
45 -r $minReadDepth
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
46 -x $maxHaploidCov
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
47 -b $bufferSize
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
48 #if $onlyTrans:
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
49 -t
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
50 #end if
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
51 -d $prefix
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
52 #if $bedFormat:
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
53 -g
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
54 #end if
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
55 <!-- -l
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
56 -a
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
57 -h
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
58 -y -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
59 <!-- parser.add_argument('-l', dest='matePair', required=False, help='analyze Illumina long insert (mate-pair) library')
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
60 # 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
61 # parser.add_argument('-h', dest='', action='store_true', help='print out Allele Frequency column', default=False)
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
62 parser.add_argument('-y', dest='scoreFilter', type=int, required=False, help='output score filter', default=30) -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
63
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
64 </command>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
65
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
66 <inputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
67 <param name="inputBamFile" format="bam" type="data" label="input bam file" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
68 <!-- optional -->
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
69 <param name="chromosome" type="text" label="operate on a single chromosome" value="" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
70 <param name="chromosome" type="integer" label="minimum length of a region" value="7" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
71 <param name="cutoff" type="integer" label="cutoff in unit of standard deviation" value="3" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
72 <param name="maxSvSize" type="integer" label="maximum SV size" value="1000000000" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
73 <param name="minMapQuality" type="integer" label="minimum alternative mapping quality" value="35" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
74 <param name="minReadDepth" type="integer" label="minimum number of read pairs required to establish a connection" value="2" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
75 <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
76 <param name="bufferSize" type="integer" label="buffer size for building connection" value="100" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
77 <param name="onlyTrans" type="boolean" label="only detect transchromosomal rearrangement" checked="False" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
78 <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
79 <param name="bedFormat" type="boolean" label="dump SVs and supporting reads in BED format for GBrowse" checked="False" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
80 </inputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
81
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
82 <outputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
83 <data name="outputRawFile" format="tabular" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
84 <data name="outputVcfFile" format="vcf" />
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
85 </outputs>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
86
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
87 <help>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
88 help
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
89 </help>
44d381ebe8a5 Uploaded
jeremie
parents:
diff changeset
90 </tool>