annotate racon.xml @ 0:51fd3136069d draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
author bgruening
date Mon, 11 Jun 2018 16:47:50 -0400
parents
children 4df02149a270
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
1 <tool id="racon" name="Racon" version="1.3.1">
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
2 <description>Consensus module for raw de novo DNA assembly of long uncorrected reads.</description>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
3 <macros>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
4 <import>macros.xml</import>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
5 </macros>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
6 <expand macro="requirements" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
7 <version_command>racon --version</version_command>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
9 ln -s '$reads' reads.${reads.ext} &&
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
10 ln -s '$overlaps' overlaps.${overlaps.ext} &&
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
11 ln -s '$corrected_reads' corrected_reads.${corrected_reads.ext} &&
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
12
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
13 racon
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
14 reads.${reads.ext}
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
15 overlaps.${overlaps.ext}
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
16 corrected_reads.${corrected_reads.ext}
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
17 -t \${GALAXY_SLOTS:-4}
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
18 $u
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
19 $f
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
20 -w $w
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
21 -q $q
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
22 -e $e
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
23 -m $m
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
24 -x $x
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
25 -g $g
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
26 > racon_polished_consensus.fa
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
27 ]]></command>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
28 <inputs>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
29 <param type="data" name="reads" format="fasta,fasta.gz,fastq,fastq.gz" label="Sequences"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
30 <param type="data" name="overlaps" format="sam" label="Overlaps"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
31 <param type="data" name="corrected_reads" format="fasta,fasta.gz,fastq,fastq.gz" label="Target sequences"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
32
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
33 <param argument="-u" type="boolean" truevalue="-u" falsevalue="" label="output unpolished target sequences" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
34 <param argument="-f" type="boolean" truevalue="-f" falsevalue="" label="perform fragment correction instead of contig polishing" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
35 <param argument="-w" type="integer" value="500" label="Size of window on which POA is performed" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
36 <param argument="-q" type="float" value="10.0" label="Threshold for average base quality of windows used in poa" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
37 <param argument="-e" type="float" value="0.3" label="Maximum allowed error rate used for filtering overlaps" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
38 <param argument="-m" type="integer" value="5" label="Score for matching bases" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
39 <param argument="-x" type="integer" value="-4" label="Score for mismatching bases" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
40 <param argument="-g" type="integer" value="-8" max="0" label="Gap penalty" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
41
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
42 </inputs>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
43 <outputs>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
44 <data name="consensus" format="fasta" from_work_dir="racon_polished_consensus.fa" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
45 </outputs>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
46 <tests>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
47 <test>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
48 <param name="reads" ftype="fasta" value="sample_reads.fasta"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
49 <param name="overlaps" ftype="sam" value="sample_overlaps.sam"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
50 <param name="corrected_reads" ftype="fasta" value="sample_layout.fasta"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
51 <param name="u" value="true"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
52 <param name="f" value="true"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
53 <param name="w" value="800"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
54 <param name="e" value="0.2"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
55 <output name="consensus" ftype="fasta" file="consensus_result2.fasta"/>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
56 </test>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
57 </tests>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
58 <help><![CDATA[
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
59
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
60 **What it does**
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
61
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
62 Consensus module for raw de novo DNA assembly of long uncorrected reads.
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
63
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
64 Racon is intended as a standalone consensus module to correct raw contigs generated by rapid assembly methods
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
65 which do not include a consensus step. The goal of Racon is to generate genomic consensus which is of similar
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
66 or better quality compared to the output generated by assembly methods which employ both error correction
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
67 and consensus steps, while providing a speedup of several times compared to those methods.
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
68 It supports data produced by both Pacific Biosciences and Oxford Nanopore Technologies.
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
69
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
70 Racon can be used as a polishing tool after the assembly with either Illumina data or data
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
71 produced by third generation of sequencing. The type of data inputed is automatically detected.
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
72
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
73 Racon takes as input only three files: contigs in FASTA/FASTQ format, reads in FASTA/FASTQ
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
74 format and overlaps/alignments between the reads and the contigs in SAM format. Output is a set of polished contigs in FASTA format printed to stdout.
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
75
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
76 Racon can also be used as a read error-correction tool. In this scenario, the SAM file needs
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
77 to contain pairwise overlaps between reads including dual overlaps.
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
78
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
79 ]]></help>
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
80 <expand macro="citations" />
51fd3136069d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/racon commit f6dd7c41a45584b478b8af48df5294e3c39f5203
bgruening
parents:
diff changeset
81 </tool>