Mercurial > repos > nilshomer > srma_wrapper
diff srma_wrapper.xml @ 0:9d60d2fce247 default tip
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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/srma_wrapper.xml Tue Jun 07 17:43:07 2011 -0400 @@ -0,0 +1,150 @@ +<tool id="srma_wrapper" name="Re-align with SRMA" version="0.1.1"> + <description></description> + <command interpreter="python"> + srma_wrapper.py + + #if $refGenomeSource.refGenomeSource == "history": + --ref=$refGenomeSource.ownFile + #else: + --ref=$refGenomeSource.ref.value + #end if + --input=$input --output=$output + --params=$params.source_select --fileSource=$refGenomeSource.refGenomeSource + #if $params.source_select == "pre_set": + --offset="None", --minMappingQuality="None", --minAlleleProbability="None", --minAlleleCoverage="None", --range="None", --correctBases="None", --useSequenceQualities="None", --maxHeapSize="None", --fileSource="None", --params="None", --dbkey="None", + #else: + --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 + #if $refGenomeSource.refGenomeSource == "history": + --dbkey=$dbkey + #else: + --dbkey="None" + #end if + </command> + <inputs> + <conditional name="refGenomeSource"> + <param name="refGenomeSource" type="select" label="Will you select a reference genome from your history or use a built-in reference?"> + <option value="built-in">Use a built-in reference</option> + <option value="history">Use one from the history</option> + </param> + <when value="built-in"> + <param name="ref" type="select" label="Select a reference genome"> + <options from_file="srma_ref.loc"> + <column name="value" index="1" /> + <column name="name" index="0" /> + </options> + </param> + </when> + <when value="history"> + <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select a reference from history" /> + </when> + </conditional> + <param name="input" type="data" format="bam" label="Input BAM file" help="The input BAM file to re-align"/> + <conditional name="params"> + <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"> + <option value="pre_set">Commonly Used</option> + <option value="full">Full Parameter List</option> + </param> + <when value="pre_set" /> + <when value="full"> + <param name="offset" type="integer" value="20" label="Offset" help="The alignment offset" /> + <param name="minMappingQuality" type="integer" value="0" label="Minimum mapping quality" help="The minimum mapping quality" /> + <param name="minAlleleProbability" type="float" value="0.1" label="Minimum allele probability" help="The minimum allele probability conditioned on coverage (for the binomial quantile)." /> + <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 " /> + <param name="range" type="text" value="null" label="Range" help="A range to examine" /> + <param name="correctBases" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Correct bases" help="Correct bases " /> + <param name="useSequenceQualities" type="boolean" truevalue="true" falsevalue="false" checked="no" label="Use sequence qualities" help="Use sequence qualities " /> + <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" /> + </when> + </conditional> + </inputs> + <outputs> + <data format="bam" name="output" /> + </outputs> + <help> +**What it does** + +SRMA is a short read micro re-aligner for next-generation high throughput sequencing data. + +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. + +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. + +------ + +Please cite the website "http://srma.sourceforge.net" as well as: + +Homer N, and Nelson SF. SRMA: short read micro re-aligner. 2010. + +------ + +**Know what you are doing** + +.. class:: warningmark + +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. + +.. __: http://srma.sourceforge.net/ + +------ + +**Input formats** + +SRMA accepts a BAM input file. + +------ + +**Outputs** + +The output is in BAM format, see http://samtools.sourceforge.net for more details. + +------- + +**SRMA settings** + +All of the options have a default value. You can change any of them. Most of the options in SRMA have been implemented here. + +------ + +**SRMA parameter list** + +This is an exhaustive list of SRMA options: + +For **SRMA**:: + + INPUT=File + I=File The input SAM or BAM file. Required. + + OUTPUT=File + O=File The output SAM or BAM file. Default value: null. + + REFERENCE=File + R=File The reference FASTA file. Required. + + OFFSET=Integer The alignment offset. Default value: 20. This option can be set to 'null' to clear the + default value. + + MIN_MAPQ=Integer The minimum mapping quality. Default value: 0. This option can be set to 'null' to clear + the default value. + + MINIMUM_ALLELE_PROBABILITY=Double + The minimum allele probability conditioned on coverage (for the binomial quantile). + Default value: 0.1. This option can be set to 'null' to clear the default value. + + MINIMUM_ALLELE_COVERAGE=Integer + The minimum haploid coverage for the consensus. Default value: 3. This option can be set + to 'null' to clear the default value. + + RANGE=String A range to examine. Default value: null. + + CORRECT_BASES=Boolean Correct bases. Default value: false. This option can be set to 'null' to clear the + default value. Possible values: {true, false} + + USE_SEQUENCE_QUALITIES=BooleanUse sequence qualities Default value: true. This option can be set to 'null' to clear the + default value. Possible values: {true, false} + + MAX_HEAP_SIZE=Integer The maximum number of nodes on the heap before re-alignment is ignored Default value: + 8192. This option can be set to 'null' to clear the default value. + + </help> + <code file="srma_wrapper_code.py" /> +</tool>