annotate sickle.xml @ 7:dd2ec1b37e96 draft default tip

Added support for the "pair"-data collection type.

<tool id="sickle" name="Sickle">
	<description>Windowed Adaptive Trimming of FastQ data</description>
	<requirements>
		<requirement type="package" version="1.21.0">sickle</requirement>
	</requirements>
	<command>
		sickle
		
		#if str($readtype.single_or_paired) == "se":
			 se
		#else
			 pe
		#end if
		
		 --quiet
		
		#if str($readtype.single_or_paired) == "se":
			 -f $input_single -t $qual_type -o $output_single
		#end if
		
		#if str($readtype.single_or_paired) == "pe":
			 -f $input_paired1 -r $input_paired2 -o $output_paired1 -p $output_paired2 -s $output_paired_single -t $qual_type
		#end if
		
		#if str($readtype.single_or_paired) == "pe_collection":
			 -f "$readtype.input_paired.forward" -r "$readtype.input_paired.reverse" -o $output_paired1 -p $output_paired2 -s $output_paired_single -t $qual_type
		#end if
		
		#if str($qual_threshold) != "":
			-q $qual_threshold
		#end if
		
		#if str($length_threshold) != "":
			 -l $length_threshold
		#end if

		#if $no_five_prime:
				 -x
		#end if

		#if $discard_n:
		-n
		#end if
	</command>
	
	<inputs>
		<!-- original wrapper code -->
		<conditional name="readtype">
			<param name="single_or_paired" type="select" optional="false" label="Single-End or Paired-End reads?">
				<option value="se" selected="true">Single-End</option>
				<option value="pe">Paired-End</option>
				<option value="pe_collection">Paired-End (as collection)</option>
			</param>
			
			<when value="se">
				<param format="fastq, fastqsanger" name="input_single" type="data" optional="false" label="Single-End FastQ Reads"/>
			</when>
			
			<when value="pe">
				<param format="fastq, fastqsanger" name="input_paired1" type="data" optional="false" label="Paired-End Forward Strand FastQ Reads"/>
				<param format="fastq, fastqsanger" name="input_paired2" type="data" optional="false" label="Paired-End Reverse Strand FastQ Reads"/>
			</when>
			
			<when value="pe_collection">
				<param format="fastq, fastqsanger" name="input_paired" type="data_collection" collection_type="paired" optional="false" label="Paired-End FastQ Reads as paired collection" />
			</when>
		</conditional>
		
		<param name="qual_type" type="select" optional="false" label="Quality type">
			<option value="illumina" selected="true">Illumina</option>
			<option value="solexa">Solexa</option>
			<option value="sanger">Sanger</option>
		</param>

		<param name="qual_threshold" value="20" type="integer" optional="true" label="Quality Threshold">
			<validator type="in_range" min="0" message="Minimum value is 0"/>
		</param>

		<param name="length_threshold" value="20" type="integer" optional="true" label="Length Threshold">
			<validator type="in_range" min="0" message="Minimum value is 0"/>
		</param>

		<param name="no_five_prime" type="boolean" label="Don't do 5' trimming"/>
		<param name="discard_n" type="boolean" label="Discard sequences with Ns"/>
	</inputs>

	<outputs>
		<data format_source="input_single" name="output_single" label="Single-End output of ${tool.name} on ${on_string}">
		<filter>(readtype['single_or_paired'] == 'se')</filter>
		</data>

		<data format_source="input_paired1" name="output_paired1" label="Paired-End forward strand output of ${tool.name} on ${on_string}">
		<filter>(readtype['single_or_paired'] == 'pe' or readtype['single_or_paired'] == 'pe_collection')</filter>
		</data>

		<data format_source="input_paired2" name="output_paired2" label="Paired-End reverse strand output of ${tool.name} on ${on_string}">
		<filter>(readtype['single_or_paired'] == 'pe' or readtype['single_or_paired'] == 'pe_collection')</filter>
		</data>

		<data format_source="input_paired1" name="output_paired_single" label="Singletons from Paired-End output of ${tool.name} on ${on_string}">
		<filter>(readtype['single_or_paired'] == 'pe' or readtype['single_or_paired'] == 'pe_collection')</filter>
		</data>
	</outputs>
	<tests>
		<param name="single_or_paired" value="pe"/>
		<param name="input_paired1" value="test.f.fastq"/>
		<param name="input_paired2" value="test.r.fastq"/>
		<param name="qual_type" value="illumina"/>
		<param name="qual_threshold" value="20"/>
		<param name="length_threshold" value="20"/>
		<param name="no_five_prime" value="false"/>
		<param name="discard_n" value="false"/>
		<output name="output_paired1" value="output.f.fastq"/>
		<output name="output_paired2" value="output.r.fastq"/>
		<output name="output_paired_single" value="output.fastq"/>
	</tests>
	
	<help>
Most modern sequencing technologies produce reads that have deteriorating quality towards the 3'-end and some towards the 5'-end as well. Incorrectly called bases in both regions negatively impact assembles, mapping, and downstream bioinformatics analyses.

Sickle is a tool that uses sliding windows along with quality and length thresholds to determine when quality is sufficiently low to trim the 3'-end of reads and also determines when the quality is sufficiently high enough to trim the 5'-end of reads. It will also discard reads based upon the length threshold. It takes the quality values and slides a window across them whose length is 0.1 times the length of the read. If this length is less than 1, then the window is set to be equal to the length of the read. Otherwise, the window slides along the quality values until the average quality in the window rises above the threshold, at which point the algorithm determines where within the window the rise occurs and cuts the read and quality there for the 5'-end cut. Then when the average quality in the window drops below the threshold, the algorithm determines where in the window the drop occurs and cuts both the read and quality strings there for the 3'-end cut. However, if the length of the remaining sequence is less than the minimum length threshold, then the read is discarded entirely. 5'-end trimming can be disabled.

Sickle also has an option to discard reads with any Ns in them.

Sickle supports three types of quality values: Illumina, Solexa, and Sanger. Note that the Solexa quality setting is an approximation (the actual conversion is a non-linear transformation). The end approximation is close. Illumina quality refers to qualities encoded with the CASAVA pipeline between versions 1.3 and 1.7. Illumina quality using CASAVA >= 1.8 is Sanger encoded.

Note that Sickle will remove the 2nd fastq record header (on the "+" line) and replace it with simply a "+". This is the default format for CASAVA >= 1.8.

Sickle also supports gzipped file inputs.
	</help>

</tool>