Mercurial > repos > nilshomer > srma_wrapper

comparison srma_wrapper.xml @ 0:9d60d2fce247 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Migrated tool version 0.1.1 from old tool shed archive to new tool shed repository
author nilshomer
date Tue, 07 Jun 2011 17:43:07 -0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:9d60d2fce247
1 <tool id="srma_wrapper" name="Re-align with SRMA" version="0.1.1">
2 <description></description>
3 <command interpreter="python">
4 srma_wrapper.py
5
6 #if $refGenomeSource.refGenomeSource == "history":
7 --ref=$refGenomeSource.ownFile
8 #else:
9 --ref=$refGenomeSource.ref.value
10 #end if
11 --input=$input --output=$output
12 --params=$params.source_select --fileSource=$refGenomeSource.refGenomeSource
13 #if $params.source_select == "pre_set":
14 --offset="None", --minMappingQuality="None", --minAlleleProbability="None", --minAlleleCoverage="None", --range="None", --correctBases="None", --useSequenceQualities="None", --maxHeapSize="None", --fileSource="None", --params="None", --dbkey="None",
15 #else:
16 --offset=$params.offset, --minMappingQuality=$params.minMappingQuality, --minAlleleProbability=$params.minAlleleProbability, --minAlleleCoverage=$params.minAlleleCoverage, --range=$params.range, --correctBases=$params.correctBases, --useSequenceQualities=$params.useSequenceQualities, --maxHeapSize=$params.maxHeapSize, --fileSource=$params.fileSource, --params=$params.params, --dbkey=$params.dbkey, #end if
17 #if $refGenomeSource.refGenomeSource == "history":
18 --dbkey=$dbkey
19 #else:
20 --dbkey="None"
21 #end if
22 </command>
23 <inputs>
24 <conditional name="refGenomeSource">
25 <param name="refGenomeSource" type="select" label="Will you select a reference genome from your history or use a built-in reference?">
26 <option value="built-in">Use a built-in reference</option>
27 <option value="history">Use one from the history</option>
28 </param>
29 <when value="built-in">
30 <param name="ref" type="select" label="Select a reference genome">
31 <options from_file="srma_ref.loc">
32 <column name="value" index="1" />
33 <column name="name" index="0" />
34 </options>
35 </param>
36 </when>
37 <when value="history">
38 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select a reference from history" />
39 </when>
40 </conditional>
41 <param name="input" type="data" format="bam" label="Input BAM file" help="The input BAM file to re-align"/>
42 <conditional name="params">
43 <param name="source_select" type="select" label="SRMA settings to use" help="For most re-alignment needs, use Commonly Used settings. If you want full control use Full Parameter List">
44 <option value="pre_set">Commonly Used</option>
45 <option value="full">Full Parameter List</option>
46 </param>
47 <when value="pre_set" />
48 <when value="full">
49 <param name="offset" type="integer" value="20" label="Offset" help="The alignment offset" />
50 <param name="minMappingQuality" type="integer" value="0" label="Minimum mapping quality" help="The minimum mapping quality" />
51 <param name="minAlleleProbability" type="float" value="0.1" label="Minimum allele probability" help="The minimum allele probability conditioned on coverage (for the binomial quantile)." />
52 <param name="minAlleleCoverage" type="integer" value="2" label="Minimum allele coverage" help="The minimum haploid coverage for the consensus. Default value: 3. This option can be set " />
53 <param name="range" type="text" value="null" label="Range" help="A range to examine" />
54 <param name="correctBases" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Correct bases" help="Correct bases " />
55 <param name="useSequenceQualities" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Use sequence qualities" help="Use sequence qualities " />
56 <param name="maxHeapSize" type="integer" value="8192" label="Maximum heap size" help="The maximum number of nodes on the heap before re-alignment is ignored" />
57 </when>
58 </conditional>
59 </inputs>
60 <outputs>
61 <data format="bam" name="output" />
62 </outputs>
63 <help>
64 **What it does**
65
66 SRMA is a short read micro re-aligner for next-generation high throughput sequencing data.
67
68 Sequence alignment algorithms examine each read independently. When indels occur towards the ends of reads, the alignment can lead to false SNPs as well as improperly placed indels. This tool aims to perform a re-alignment of each read to a graphical representation of all alignments within a local region to provide a better overall base-resolution consensus.
69
70 Currently this tool works well with and has been tested on 30x diploid coverage genome sequencing data from Illumina and ABI SOLiD technology. This tool may not work well with 454 data, as indels are a significant error mode for 454 data.
71
72 ------
73
74 Please cite the website "http://srma.sourceforge.net" as well as:
75
76 Homer N, and Nelson SF. SRMA: short read micro re-aligner. 2010.
77
78 ------
79
80 **Know what you are doing**
81
82 .. class:: warningmark
83
84 There is no such thing (yet) as an automated gearshift in short read mapping. It is all like stick-shift driving in San Francisco. In other words = running this tool with default parameters will probably not give you meaningful results. A way to deal with this is to **understand** the parameters by carefully reading the `documentation`__ and experimenting. Fortunately, Galaxy makes experimenting easy.
85
86 .. __: http://srma.sourceforge.net/
87
88 ------
89
90 **Input formats**
91
92 SRMA accepts a BAM input file.
93
94 ------
95
96 **Outputs**
97
98 The output is in BAM format, see http://samtools.sourceforge.net for more details.
99
100 -------
101
102 **SRMA settings**
103
104 All of the options have a default value. You can change any of them. Most of the options in SRMA have been implemented here.
105
106 ------
107
108 **SRMA parameter list**
109
110 This is an exhaustive list of SRMA options:
111
112 For **SRMA**::
113
114 INPUT=File
115 I=File The input SAM or BAM file. Required.
116
117 OUTPUT=File
118 O=File The output SAM or BAM file. Default value: null.
119
120 REFERENCE=File
121 R=File The reference FASTA file. Required.
122
123 OFFSET=Integer The alignment offset. Default value: 20. This option can be set to 'null' to clear the
124 default value.
125
126 MIN_MAPQ=Integer The minimum mapping quality. Default value: 0. This option can be set to 'null' to clear
127 the default value.
128
129 MINIMUM_ALLELE_PROBABILITY=Double
130 The minimum allele probability conditioned on coverage (for the binomial quantile).
131 Default value: 0.1. This option can be set to 'null' to clear the default value.
132
133 MINIMUM_ALLELE_COVERAGE=Integer
134 The minimum haploid coverage for the consensus. Default value: 3. This option can be set
135 to 'null' to clear the default value.
136
137 RANGE=String A range to examine. Default value: null.
138
139 CORRECT_BASES=Boolean Correct bases. Default value: false. This option can be set to 'null' to clear the
140 default value. Possible values: {true, false}
141
142 USE_SEQUENCE_QUALITIES=BooleanUse sequence qualities Default value: true. This option can be set to 'null' to clear the
143 default value. Possible values: {true, false}
144
145 MAX_HEAP_SIZE=Integer The maximum number of nodes on the heap before re-alignment is ignored Default value:
146 8192. This option can be set to 'null' to clear the default value.
147
148 </help>
149 <code file="srma_wrapper_code.py" />
150 </tool>