annotate fastq-join.xml @ 3:f0d19a935325 draft default tip

Uploaded
author lparsons
date Tue, 20 Nov 2012 16:01:20 -0500
parents 71eaf2e85ae7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
1 <tool id="fastq_join" name="fastq-join" version="0.1.1">
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
2 <description> - Joins two paired-end reads on the overlapping ends</description>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
3 <requirements>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
4 <requirement type="package" version="1.1.2-484">ea-utils</requirement>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
5 </requirements>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
6 <command>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
7 fastq-join
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
8 -v '$splitChar'
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
9 -p $pctMaxDiff
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
10 -m $minOverlap
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
11 #if $stitchLengthReport:
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
12 -r $outputStitchLengthReport
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
13 #end if
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
14 $read1
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
15 $read2
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
16 -o $outputUnmatched1 -o $outputUnmatched2 -o $outputJoined
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
17 </command>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
18 <inputs>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
19 <param format="fastq, fastqillumina, fastqsanger, fastqsolexa" name="read1" type="data" label="Read 1 Fastq" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
20 <param format="fastq, fastqillumina, fastqsanger, fastqsolexa" name="read2" type="data" label="Read 2 Fastq" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
21 <param name="splitChar" type="text" value=" " label="Split read ids on this character" help="Default is space ' ' for Illumina reads" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
22 <param name="pctMaxDiff" type="float" value="8" min="0" max="100" label="Maximum percentage difference between matching segments" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
23 <param name="minOverlap" type="integer" value="6" min="1" label="Minimum length of matching segements" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
24 <param name="stitchLengthReport" type="boolean" value="False" label="Output verbose stitch length report" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
25 </inputs>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
26
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
27 <outputs>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
28 <data format="input" format_source="read1" name="outputJoined" label="${tool.name} on ${on_string} (joined)"/>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
29 <data format="input" format_source="read1" name="outputUnmatched1" label="${tool.name} on ${on_string} (unmatched1)"/>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
30 <data format="input" format_source="read2" name="outputUnmatched2" label="${tool.name} on ${on_string} (unmatched2)"/>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
31 <data format="tabular" name="outputStitchLengthReport" label="${tool.name} on ${on_string} (stitch length report)">
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
32 <filter>stitchLengthReport</filter>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
33 </data>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
34 </outputs>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
35
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
36 <stdio>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
37 <exit_code range="1:" level="fatal" description="Unknown error occurred" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
38 </stdio>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
39
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
40 <tests>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
41 <test>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
42 <param name="read1" value="test_read1.fastq" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
43 <param name="read2" value="test_read3.fastq" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
44 <output name="outputJoined" file="testout.join.fastq" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
45 <output name="outputUnmatched1" file="testout.un1.fastq" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
46 <output name="outputUnmatched2" file="testout.un2.fastq" />
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
47 </test>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
48 </tests>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
49
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
50 <help>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
51 Overview
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
52 --------
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
53 fastq-join joins two paired-end reads on the overlapping ends.
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
54
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
55 Split read ids character: Verifies that the 2 files probe id's match up to char C. Use ' ' for Illumina reads.
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
56
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
57 Maximum difference is the maximum allowed percentage of bases that differ in the matching region.
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
58
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
59 Minimum overlap is the minimum number of bases that must overlap (with no more than the maximum difference) for reads to be joined.
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
60
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
61 Verbose stitch length report is a report for each joined paired of reads showing how large the overlapping section was.
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
62
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
63 This tool uses sqr(distance)/len for anchored alignment quality algorithm. It's a good measure of anchored alignment quality, akin to squared-deviation for means. This tool uses the fastq-join program that is part of the ea-utils suite. See http://code.google.com/p/ea-utils/wiki/FastqJoin for details.
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
64 </help>
71eaf2e85ae7 Uploaded
lparsons
parents:
diff changeset
65 </tool>