annotate sopra_wpc.xml @ 2:87ffe493b6c1 draft default tip

Use GALAXY_SLOTS for multithreading in Bowtie. Create symlinks instead of copying files. Specify in help that Bowtie is used to align the reads to the contigs. Add readme.rst .
author crs4
date Mon, 03 Mar 2014 11:28:41 -0500
parents 988d5a82291a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
988d5a82291a Uploaded
crs4
parents:
diff changeset
1 <tool id="sopra_wpc" name="SOPRA with prebuilt contigs" version="0.1">
2
87ffe493b6c1 Use GALAXY_SLOTS for multithreading in Bowtie. Create symlinks instead of copying files. Specify in help that Bowtie is used to align the reads to the contigs. Add readme.rst .
crs4
parents: 0
diff changeset
2 <description>for Illumina libraries</description>
0
988d5a82291a Uploaded
crs4
parents:
diff changeset
3 <requirements>
988d5a82291a Uploaded
crs4
parents:
diff changeset
4 <requirement type="package" version="1.4.6">sopra</requirement>
988d5a82291a Uploaded
crs4
parents:
diff changeset
5 <requirement type="package" version="1.0.0">bowtie</requirement>
988d5a82291a Uploaded
crs4
parents:
diff changeset
6 </requirements>
988d5a82291a Uploaded
crs4
parents:
diff changeset
7 <command interpreter="python">
2
87ffe493b6c1 Use GALAXY_SLOTS for multithreading in Bowtie. Create symlinks instead of copying files. Specify in help that Bowtie is used to align the reads to the contigs. Add readme.rst .
crs4
parents: 0
diff changeset
8 sopra_wpc.py -p \${GALAXY_SLOTS:-1}
0
988d5a82291a Uploaded
crs4
parents:
diff changeset
9 #for $cr in $contigs_repeat
988d5a82291a Uploaded
crs4
parents:
diff changeset
10 --contigs ${cr.contigs_file}
988d5a82291a Uploaded
crs4
parents:
diff changeset
11 #end for
988d5a82291a Uploaded
crs4
parents:
diff changeset
12 #for $mr in $mate_repeat
988d5a82291a Uploaded
crs4
parents:
diff changeset
13 --mate ${mr.mate_file}
988d5a82291a Uploaded
crs4
parents:
diff changeset
14 -d ${mr.insert_size}
988d5a82291a Uploaded
crs4
parents:
diff changeset
15 #end for
988d5a82291a Uploaded
crs4
parents:
diff changeset
16 -v $max_mismatches -c $c_option -w $w_option -L $L_option --h_option $h_option --scaffolds $scaffolds_file --logfile $logfile
988d5a82291a Uploaded
crs4
parents:
diff changeset
17 </command>
988d5a82291a Uploaded
crs4
parents:
diff changeset
18 <inputs>
988d5a82291a Uploaded
crs4
parents:
diff changeset
19 <repeat name="contigs_repeat" title="Contigs file" min="1">
988d5a82291a Uploaded
crs4
parents:
diff changeset
20 <param name="contigs_file" type="data" format="fasta" label="Contigs" help="FASTA format" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
21 </repeat>
988d5a82291a Uploaded
crs4
parents:
diff changeset
22 <repeat name="mate_repeat" title="Paired-end Illumina library" min="1">
988d5a82291a Uploaded
crs4
parents:
diff changeset
23 <param name="mate_file" type="data" format="fasta" label="Paired-end Illumina library" help="FASTA format" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
24 <param name="insert_size" type="integer" value="" label="Insert size" help="Insert size for the library (-d)" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
25 </repeat>
988d5a82291a Uploaded
crs4
parents:
diff changeset
26 <param name="max_mismatches" type="integer" min="0" max="3" value="0" label="Maximum number of mismatches when aligning reads on contigs with Bowtie (-v)" help="May be 0, 1, 2, or 3" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
27 <param name="c_option" type="integer" value="5" label="If the number of times a read and its reverse complement appear in the library is equal to or more than this value, the pairing information from that read will be disregarded (-c)" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
28 <param name="w_option" type="integer" value="4" label="Minimum number of links between two contigs (-w)" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
29 <param name="L_option" type="integer" value="150" label="Minimum length of contigs to be used in scaffold assembly (-L)" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
30 <param name="h_option" type="float" value="2.2" label="h value (-h)" help="High coverage contigs (above mean_coverage + h x std_coverage) are not considered in the scaffold assembly mainly to exclude reads from repetitive regions" />
988d5a82291a Uploaded
crs4
parents:
diff changeset
31 </inputs>
988d5a82291a Uploaded
crs4
parents:
diff changeset
32 <outputs>
988d5a82291a Uploaded
crs4
parents:
diff changeset
33 <data format="fasta" name="scaffolds_file" label="${tool.name} on ${on_string}: scaffolds_sopra.fasta"/>
988d5a82291a Uploaded
crs4
parents:
diff changeset
34 <data format="txt" name="logfile" label="${tool.name} on ${on_string}: log"/>
988d5a82291a Uploaded
crs4
parents:
diff changeset
35 </outputs>
988d5a82291a Uploaded
crs4
parents:
diff changeset
36 <help>
988d5a82291a Uploaded
crs4
parents:
diff changeset
37 **What it does**
988d5a82291a Uploaded
crs4
parents:
diff changeset
38
2
87ffe493b6c1 Use GALAXY_SLOTS for multithreading in Bowtie. Create symlinks instead of copying files. Specify in help that Bowtie is used to align the reads to the contigs. Add readme.rst .
crs4
parents: 0
diff changeset
39 SOPRA is a scaffold assembly tool for paired-end/mate pair data generated by high-throughput sequencing technologies, e.g. Illumina and SOLiD platforms. This wrapper currently supports only Illumina paired-end data.
87ffe493b6c1 Use GALAXY_SLOTS for multithreading in Bowtie. Create symlinks instead of copying files. Specify in help that Bowtie is used to align the reads to the contigs. Add readme.rst .
crs4
parents: 0
diff changeset
40
87ffe493b6c1 Use GALAXY_SLOTS for multithreading in Bowtie. Create symlinks instead of copying files. Specify in help that Bowtie is used to align the reads to the contigs. Add readme.rst .
crs4
parents: 0
diff changeset
41 Bowtie is used to align the reads to the contigs.
0
988d5a82291a Uploaded
crs4
parents:
diff changeset
42
988d5a82291a Uploaded
crs4
parents:
diff changeset
43 The input paired-end FASTA file can be obtained with:
988d5a82291a Uploaded
crs4
parents:
diff changeset
44 FR reads -> *FASTQ interlacer on paired end reads* followed by *FASTQ to FASTA* converter
988d5a82291a Uploaded
crs4
parents:
diff changeset
45 RF reads -> *Reverse-Complement*, *FASTQ interlacer on paired end reads* followed by *FASTQ to FASTA* converter
988d5a82291a Uploaded
crs4
parents:
diff changeset
46
988d5a82291a Uploaded
crs4
parents:
diff changeset
47 .. class:: infomark
988d5a82291a Uploaded
crs4
parents:
diff changeset
48
988d5a82291a Uploaded
crs4
parents:
diff changeset
49 **TIP:** Try trimming the end of short reads before feeding it to the assembler to remove the error prone bases (e.g. last 10 to 20 bps) and check if it improves the assembly.
988d5a82291a Uploaded
crs4
parents:
diff changeset
50
988d5a82291a Uploaded
crs4
parents:
diff changeset
51 -----
988d5a82291a Uploaded
crs4
parents:
diff changeset
52
988d5a82291a Uploaded
crs4
parents:
diff changeset
53 **License and citation**
988d5a82291a Uploaded
crs4
parents:
diff changeset
54
988d5a82291a Uploaded
crs4
parents:
diff changeset
55 This Galaxy tool is Copyright © 2013 `CRS4 Srl.`_ and is released under the `MIT license`_.
988d5a82291a Uploaded
crs4
parents:
diff changeset
56
988d5a82291a Uploaded
crs4
parents:
diff changeset
57 .. _CRS4 Srl.: http://www.crs4.it/
988d5a82291a Uploaded
crs4
parents:
diff changeset
58 .. _MIT license: http://opensource.org/licenses/MIT
988d5a82291a Uploaded
crs4
parents:
diff changeset
59
988d5a82291a Uploaded
crs4
parents:
diff changeset
60 If you use this tool in Galaxy, please cite |Cuccuru2013|_.
988d5a82291a Uploaded
crs4
parents:
diff changeset
61
988d5a82291a Uploaded
crs4
parents:
diff changeset
62 .. |Cuccuru2013| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2013) Orione, a web-based framework for NGS analysis in microbiology. *Submitted*
988d5a82291a Uploaded
crs4
parents:
diff changeset
63 .. _Cuccuru2013: http://orione.crs4.it/
988d5a82291a Uploaded
crs4
parents:
diff changeset
64
988d5a82291a Uploaded
crs4
parents:
diff changeset
65 This tool uses `SOPRA`_, which is licensed separately. Please cite |Dayarian2010|_.
988d5a82291a Uploaded
crs4
parents:
diff changeset
66
988d5a82291a Uploaded
crs4
parents:
diff changeset
67 .. _SOPRA: http://www.physics.rutgers.edu/~anirvans/SOPRA/
988d5a82291a Uploaded
crs4
parents:
diff changeset
68 .. |Dayarian2010| replace:: Dayarian, A., Michael, T. P., Sengupta, A. M. (2010) SOPRA: Scaffolding algorithm for paired reads via statistical optimization. *BMC Bioinformatics* 11, 345
988d5a82291a Uploaded
crs4
parents:
diff changeset
69 .. _Dayarian2010: http://www.biomedcentral.com/1471-2105/11/345/
988d5a82291a Uploaded
crs4
parents:
diff changeset
70 </help>
988d5a82291a Uploaded
crs4
parents:
diff changeset
71 </tool>