annotate flexbar.xml @ 19:621fa3daa2a1

Updated tool definition for Flexbar 2.33 release

<!-- Flexbar tool definition for Galaxy, version 2.33 -->
<!-- Author: Johannes Roehr -->

<tool id="flexbar" name="Flexbar" version="2.33" force_history_refresh="True">

	<description>flexible barcode and adapter removal</description>
    
	<requirements>
        <requirement type="binary" version="2.33">flexbar</requirement>
    </requirements>
	
	<version_command>flexbar --version</version_command>
	
	<command interpreter="perl">
		
		flexbar.pl flexbar
		
		--threads $threads
		
		--reads $reads
		
		#if $cReads2.select == "on":
			#if $cReads2.reads2.ext == $reads.ext:
				--reads2 $cReads2.reads2
			#end if
		#end if
		
		
		#if $reads.ext == "fasta":
			--format fasta
		#end if
		#if $reads.ext == "fastq":
			--format fastq
		#end if
		#if $reads.ext == "fastqsanger":
			--format fastq-sanger
		#end if
		#if $reads.ext == "fastqsolexa":
			--format fastq-solexa
		#end if
		#if $reads.ext == "fastqillumina":
			--format fastq-i1.3
		#end if
		#if $reads.ext == "csfasta":
			--format csfasta
		#end if
		#if $reads.ext == "fastqcssanger":
			--format csfastq
		#end if
		
		
		--max-uncalled $maxUncalled
		--min-readlength $minReadLen
		
		#if $trimEnds.select == "on":
			--pre-trim-left $trimEnds.trimLeft
			--pre-trim-right $trimEnds.trimRight
		#end if
		
		#if $cTrimPhred.select == "on":
			--pre-trim-phred $cTrimPhred.trimPhred
		#end if
		
		#if $cTrimLen.select == "on":
			--post-trim-length $cTrimLen.trimLen
		#end if
		
		
		#if $cBarcodes.select == "on":
			--barcodes $cBarcodes.barcodes
			
			#if $cBarcodes.cbReads.select == "yes":
				--barcode-reads $cBarcodes.cbReads.bReads
			#end if
			
			#if $cBarcodes.cbReads.select == "no":
				$cBarcodes.cbReads.bKeep
			#end if
			
			--barcode-trim-end $cBarcodes.bTrimEnd
			
			#if $cBarcodes.cbTailLen.select == "yes":
				--barcode-tail-length $cBarcodes.cbTailLen.bTailLen
			#end if
			
			#if $cBarcodes.cbMinOverlap.select == "yes":
				--barcode-min-overlap $cBarcodes.cbMinOverlap.bMinOverlap
			#end if
			
			--barcode-threshold   $cBarcodes.bThresh
			
			#if $cBarcodes.cbAlignScores.select == "yes":
				--barcode-match    $bMatch
				--barcode-mismatch $bMismatch
				--barcode-gap      $bGap
			#end if
		#end if
		
		
		#if $cAdapters.select == "on":
			
			#if $cAdapters.ccAdapters.select == "data":
				--adapters $cAdapters.ccAdapters.adaptersData
			#end if
			
			#if $cAdapters.ccAdapters.select == "seq":
				--adapter-seq $cAdapters.ccAdapters.adapterSeq
			#end if
			
			--adapter-trim-end $cAdapters.aTrimEnd
			
			#if $cAdapters.caTailLen.select == "yes":
				--adapter-tail-length $cAdapters.caTailLen.aTailLen
			#end if
			
			--adapter-min-overlap $cAdapters.aMinOverlap
			--adapter-threshold   $cAdapters.aThresh
			
			#if $cAdapters.caAlignScores.select == "yes":
				--adapter-match    $aMatch
				--adapter-mismatch $aMismatch
				--adapter-gap      $aGap
			#end if
		#end if
		
		
		#if $cLogging.select == "show":
			$cLogging.logLevel
			$cLogging.singleReads
			$cLogging.lenDist
			$cLogging.fastaOutput
			$cLogging.numTags
			$cLogging.remTags
			$cLogging.rndTags
		#end if
		
		
		$output $output.id $__new_file_path__ $reads.ext
		
	</command>
	
	<inputs>
		
		<param format="fasta,fastq,fastqsanger,fastqsolexa,fastqillumina,csfasta,fastqcssanger" name="reads" type="data" label="Sequencing reads" optional="false"/>
		
		
		<conditional name="cReads2">
			<param name="select" type="select" label="2nd read set (paired)">
				<option value="off" selected="true">Off</option>
				<option value="on">On</option>
			</param>
			<when value="on">
				<param format="fasta,fastq,fastqsanger,fastqsolexa,fastqillumina,csfasta,fastqcssanger" name="reads2" type="data" label="Reads 2" optional="false" help="same format as first read set"/>
			</when>
		</conditional>
		
		
		<param name="maxUncalled" size="4" type="integer" value="0"  label="1) Max uncalled" optional="false" help="allowed uncalled bases per read"/>
		
		<conditional name="trimEnds">
			<param name="select" type="select" label="2) Trimming of ends">
				<option value="off" selected="true">Off</option>
				<option value="on">On</option>
			</param>
			<when value="on">
				<param name="trimLeft" size="4" type="integer" value="0" label="Left" optional="false"/>
				<param name="trimRight" size="4" type="integer" value="0" label="Right" optional="false" help="trims specified number of bases from read ends"/>
			</when>
		</conditional>
		
		<conditional name="cTrimPhred">
			<param name="select" type="select" label="3) Phred-trimming">
				<option value="off" selected="true">Off</option>
				<option value="on">On</option>
			</param>
			<when value="on">
				<param name="trimPhred" size="4" type="integer" value="10" label="Threshold" optional="false" help="trim right end until specified or higher quality reached"/>
			</when>
		</conditional>
		
		
		<conditional name="cBarcodes">
			<param name="select" type="select" label="4) Barcode detection">
				<option value="off" selected="true">Off</option>
				<option value="on">On</option>
			</param>
			<when value="on">
				<param format="fasta" name="barcodes" type="data" label="Barcodes" optional="false"/>
				<conditional name="cbReads">
					<param name="select" type="select" label="Separate barcode reads">
						<option value="no" selected="true">No</option>
						<option value="yes">Yes</option>
					</param>
					<when value="yes">
						<param format="fasta,fastq,fastqsanger,fastqsolexa,fastqillumina,csfasta,fastqcssanger" name="bReads" type="data" label="Separate barcode reads" optional="false"/>
					</when>
					<when value="no">
						<param name="bKeep" type="select" label="Remove barcodes within reads">
							<option value="" selected="true">Yes</option>
							<option value="--barcode-keep">No</option>
						</param>
					</when>
				</conditional>
				<param name="bTrimEnd" type="select" label="Trim-end mode" optional="false">
					<option value="ANY" selected="true">Any</option>
					<option value="RIGHT">Right</option>
					<option value="RIGHT_TAIL">Right tail</option>
					<option value="LEFT">Left</option>
					<option value="LEFT_TAIL">Left tail</option>
				</param>
				<conditional name="cbTailLen">
					<param name="select" type="select" label="Change tail length">
						<option value="no" selected="true">No</option>
						<option value="yes">Yes</option>
					</param>
					<when value="yes">
						<param name="bTailLen" size="4" type="integer" value="10" label="Tail length" optional="false"/>
					</when>
				</conditional>
				
				<conditional name="cbMinOverlap">
					<param name="select" type="select" label="Change min-overlap" help="default: barcode length">
						<option value="no" selected="true">No</option>
						<option value="yes">Yes</option>
					</param>
					<when value="yes">
						<param name="bMinOverlap" size="4" type="integer" value="8" label="Min-overlap" optional="false"/>
					</when>
				</conditional>
				
				<param name="bThresh" size="4" type="integer" value="1" label="Threshold" optional="false" help="allowed mismatches and indels per 10 bases"/>
				
				<conditional name="cbAlignScores">
					<param name="select" type="select" label="Modify alignment scores">
						<option value="no" selected="true">No</option>
						<option value="yes">Yes</option>
					</param>
					<when value="yes">
						<param name="bMatch"    size="3" type="integer" value="1"  label="Match" optional="false"/>
						<param name="bMismatch" size="3" type="integer" value="-1" label="Mismatch" optional="false"/>
						<param name="bGap"      size="3" type="integer" value="-7" label="Gap" optional="false"/>
					</when>
				</conditional>
			</when>
		</conditional>
		
		
		<conditional name="cAdapters">
			<param name="select" type="select" label="5) Adapter removal">
				<option value="off" selected="true">Off</option>
				<option value="on">On</option>
			</param>
			
			<when value="on">
				<conditional name="ccAdapters">
					<param name="select" type="select" label="Adapter source">
						<option value="data" selected="true">Fasta</option>
						<option value="seq">Sequence</option>
						<!-- <option value="file">File</option> -->
					</param>
					<when value="data">
						<param format="fasta" name="adaptersData" type="data" label="Adapters" optional="false"/>
					</when>
					<when value="seq">
						<param name="adapterSeq" size="40" label="Adapter" type="text" value="AAAAAAAAAAAAAA" optional="false"/>
					</when>
					<!-- <when value="file">
						<param name="adaptersFile" type="file" label="Adapters file" optional="false"/>
					</when> -->
				</conditional>
				
				<param name="aTrimEnd" type="select" label="Trim-end mode" optional="false">
					<option value="ANY">Any</option>
					<option value="RIGHT" selected="true">Right</option>
					<option value="RIGHT_TAIL">Right tail</option>
					<option value="LEFT">Left</option>
					<option value="LEFT_TAIL">Left tail</option>
				</param>
				
				<conditional name="caTailLen">
					<param name="select" type="select" label="Change tail length">
						<option value="no" selected="true">No</option>
						<option value="yes">Yes</option>
					</param>
					<when value="yes">
						<param name="aTailLen" size="4" type="integer" value="10" label="Tail length" optional="false"/>
					</when>
				</conditional>
				
				<param name="aMinOverlap" size="4" type="integer" value="1" label="Min-overlap" optional="false"/>
				<param name="aThresh" size="4" type="integer" value="3" label="Threshold" optional="false" help="allowed mismatches and indels per 10 bases"/>
				
				<conditional name="caAlignScores">
					<param name="select" type="select" label="Modify alignment scores">
						<option value="no" selected="true">No</option>
						<option value="yes">Yes</option>
					</param>
					<when value="yes">
						<param name="aMatch"    size="3" type="integer" value="1"  label="Match" optional="false"/>
						<param name="aMismatch" size="3" type="integer" value="-1" label="Mismatch" optional="false"/>
						<param name="aGap"      size="3" type="integer" value="-7" label="Gap" optional="false"/>
					</when>
				</conditional>
			</when>
		</conditional>
		
		
		<conditional name="cTrimLen">
			<param name="select" type="select" label="6) Trimming to length">
				<option value="off" selected="true">Off</option>
				<option value="on">On</option>
			</param>
			<when value="on">
				<param name="trimLen" size="4" type="integer" value="30" label="Length" optional="false" help="trim reads to certain length from right"/>
			</when>
		</conditional>
		
		<param name="minReadLen"  size="4" type="integer" value="18" label="7) Minimum read length" optional="false" help="shorter reads are discarded"/>
		
		
		<conditional name="cLogging">
			<param name="select" type="select" label="Logging and tagging options">
				<option value="off" selected="true">Off</option>
				<option value="show">Show</option>
			</param>
			<when value="show">
				<param name="logLevel" type="select" label="Alignment logging">
					<option value="" selected="true">Off</option>
					<option value="--log-level ALL">All</option>
					<option value="--log-level MOD">Modified</option>
					<option value="--log-level TAB">Tabular</option>
				</param>
				
				<param name="singleReads" type="select" label="Single reads">
					<option value="" selected="true">Off</option>
					<option value="--single-reads">On</option>
				</param>
				
				<param name="lenDist" type="select" label="Read length distribution">
					<option value="" selected="true">Off</option>
					<option value="--length-dist">On</option>
				</param>
				
				<param name="fastaOutput" type="select" label="Fasta output">
					<option value="" selected="true">Off</option>
					<option value="--fasta-output">Always</option>
				</param>
				
				<param name="numTags" type="select" label="Number tags">
					<option value="" selected="true">Off</option>
					<option value="--number-tags">On</option>
				</param>
				
				<param name="remTags" type="select" label="Removal tags">
					<option value="" selected="true">Off</option>
					<option value="--removal-tags">On</option>
				</param>
				
				<param name="rndTags" type="select" label="Random tags">
					<option value="" selected="true">Off</option>
					<option value="--random-tags">On</option>
				</param>
			</when>
		</conditional>
		
		<param name="threads" type="select" label="Threads" help="check availability of cores">
		    <option value="1" selected="true">1</option>
		    <option value="2">2</option>
			<option value="4">4</option>
		</param>
		
  	</inputs>
 	
	<stdio>
	    <exit_code range="1:" level="fatal" description="Error!" />
	</stdio>
	
	<outputs>
	    <data format="txt" name="output" metadata_source="reads"/>
	</outputs>
	
	
	<help>

**Description**

Flexbar is a program to preprocess sequencing data. It demultiplexes barcoded runs and removes adapter sequences. Further, basic read trimming and filtering options are provided. Flexbar increases mapping rates and improves genome and transcriptome assemblies. It supports next-generation sequencing data in fasta/q and csfasta/q format from Illumina, Roche 454, and the SOLiD platform. Flexbar is available on the project_ page.

.. _project: https://sourceforge.net/projects/flexbar

------

**Trim-end modes**

**Any:** longer part of read remains

**Left:** align before or at read end, right part remains

**Right:** align after or at read start, left part remains

**Left tail:** consider first n bases, see tail-length options

**Right tail:** use only last n bases of reads in alignment

------

**Documentation**

Further documentation is available on the `manual`__ wiki page and via the command line help screen.

.. __: http://sourceforge.net/p/flexbar/wiki

------

**Reference**

Matthias Dodt, Johannes T. Roehr, Rina Ahmed, Christoph Dieterich: Flexbar — flexible barcode and adapter processing for next-generation sequencing platforms. Biology 2012, 1(3):895-905.

	</help>

</tool>