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

planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
author lparsons
date Wed, 16 Dec 2015 16:01:08 -0500
parents b007d9642911
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
1 <tool id="fastq_join" name="fastq-join" version="1.1.2-806.1">
1
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
2 <description> - Joins two paired-end reads on the overlapping ends</description>
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
3
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
4 <requirements>
2
b007d9642911 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 1a3c419bc0ded7c40cb2bc3e7c87bfb01ddfeba2
lparsons
parents: 1
diff changeset
5 <requirement type="package" version="1.1.2-806">ea-utils</requirement>
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
6 </requirements>
1
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
7
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
8 <stdio>
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
9 <exit_code range="1:" level="fatal" description="Unknown error occurred" />
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
10 </stdio>
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
11
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
12 <command><![CDATA[
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
13 fastq-join
3
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
14 -v "${splitChar}"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
15 -p "${pctMaxDiff}"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
16 -m "${minOverlap}"
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
17 #if $stitchLengthReport:
3
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
18 -r "${outputStitchLengthReport}"
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
19 #end if
3
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
20 #if str( $input_type.input_type_selector ) == 'paired':
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
21 "${input_type.read1}"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
22 "${input_type.read2}"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
23 #else:
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
24 "${input_type.input_collection.forward}"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
25 "${input_type.input_collection.reverse}"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
26 #end if
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
27 -o "${outputUnmatched1}" -o "${outputUnmatched2}" -o "${outputJoined}"
1
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
28 ]]>
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
29 </command>
1
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
30
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
31 <inputs>
3
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
32 <conditional name="input_type">
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
33 <param name="input_type_selector" type="select" label="Dataset type">
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
34 <option value="paired">Paired-end</option>
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
35 <option value="paired_collection">Paired-end Dataset Collection</option>
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
36 </param>
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
37 <when value="paired">
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
38 <param format="fastqsanger" name="read1" type="data" label="Read 1 Fastq" help="Nucleotide-space: Must have PHRED-scaled quality values with offset 33 (fastqsanger)." />
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
39 <param format="fastqsanger" name="read2" type="data" label="Read 2 Fastq" help="Nucleotide-space: Must have PHRED-scaled quality values with offset 33 (fastqsanger)." />
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
40 </when>
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
41 <when value="paired_collection">
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
42 <param name="input_collection" format="fastqsanger"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
43 type="data_collection" collection_type="paired"
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
44 label="FASTQ Paired Dataset" help="Nucleotide-space: Must have PHRED-scaled quality values with offset 33 (fastqsanger)." />
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
45 </when>
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
46 </conditional>
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
47 <param name="splitChar" type="text" value=" " label="Split read ids on this character" help="Default is space ' ' for Illumina reads" />
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
48 <param name="pctMaxDiff" type="float" value="8" min="0" max="100" label="Maximum percentage difference between matching segments" />
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
49 <param name="minOverlap" type="integer" value="6" min="1" label="Minimum length of matching segements" />
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
50 <param name="stitchLengthReport" type="boolean" value="False" label="Output verbose stitch length report" />
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
51 </inputs>
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
52
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
53 <outputs>
3
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
54 <data format="fastqsanger" name="outputJoined" label="${tool.name} on ${on_string} (joined)"/>
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
55 <data format="fastqsanger" name="outputUnmatched1" label="${tool.name} on ${on_string} (unmatched1)"/>
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
56 <data format="fastqsanger" name="outputUnmatched2" label="${tool.name} on ${on_string} (unmatched2)"/>
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
57 <data format="tabular" name="outputStitchLengthReport" label="${tool.name} on ${on_string} (stitch length report)">
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
58 <filter>stitchLengthReport</filter>
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
59 </data>
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
60 </outputs>
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
61
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
62 <tests>
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
63 <test>
3
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
64 <param name="read1" value="test_read1.fastq" ftype="fastqsanger" />
8ec3dfde378b planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit a7f8461032de196092033c9ceae9f4407a469c44
lparsons
parents: 2
diff changeset
65 <param name="read2" value="test_read3.fastq" ftype="fastqsanger" />
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
66 <output name="outputJoined" file="testout.join.fastq" />
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
67 <output name="outputUnmatched1" file="testout.un1.fastq" />
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
68 <output name="outputUnmatched2" file="testout.un2.fastq" />
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
69 </test>
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
70 </tests>
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
71
1
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
72 <help><![CDATA[
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
73 Overview
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
74 --------
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
75 fastq-join joins two paired-end reads on the overlapping ends.
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
76
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
77 Split read ids character: Verifies that the 2 files probe id's match up to char C. Use ' ' for Illumina reads.
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
78
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
79 Maximum difference is the maximum allowed percentage of bases that differ in the matching region.
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
80
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
81 Minimum overlap is the minimum number of bases that must overlap (with no more than the maximum difference) for reads to be joined.
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
82
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
83 Verbose stitch length report is a report for each joined paired of reads showing how large the overlapping section was.
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
84
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
85 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.
1
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
86 ]]>
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
87 </help>
1
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
88
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
89 <citations>
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
90 <citation type="bibtex">
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
91 @article{aronesty_comparison_2013,
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
92 title = {Comparison of {Sequencing} {Utility} {Programs}},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
93 volume = {7},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
94 issn = {18750362},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
95 url = {http://benthamopen.com/ABSTRACT/TOBIOIJ-7-1},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
96 doi = {10.2174/1875036201307010001},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
97 language = {en},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
98 number = {1},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
99 urldate = {2015-07-10},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
100 journal = {The Open Bioinformatics Journal},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
101 author = {Aronesty, Erik},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
102 month = jan,
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
103 year = {2013},
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
104 pages = {1--8}
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
105 }
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
106 </citation>
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
107 </citations>
593a729e5706 planemo upload for repository https://github.com/lparsons/galaxy_tools/tree/master/tools/fastq_join commit 394834f8f34909961cfbf6252fefbdc63342d78d
lparsons
parents: 0
diff changeset
108
0
2ac846969812 Uploaded initial version with package dependency
lparsons
parents:
diff changeset
109 </tool>