annotate iAssembler_README.txt @ 5:1d53d653adef draft default tip

iAssembler perl wrapper dependency
author rogerngo
date Wed, 16 May 2012 00:24:38 -0400
parents cfe16849421e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
1 iAssembler tools for Galaxy
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
2
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
3 iAssembler is a standalone package to assemble ESTs generated using Sanger and/or Roche-454 pyrosequencing technologies into contigs.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
4 The pipeline gives much higher accuracy in EST assembly than other existing assemblers by employing an iterative assembly strategy and automated
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
5 error corrections of mis-assemblies.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
6
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
7 iAssembler first performs iterative assemblies using MIRA and CAP3 (default: four cycles of MIRA assemblies followed by one CAP3 assembly) to correct
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
8 assembly errors (mostly sequences derived from the same transcript fail to be assembled together) which occur frequently in just one round of assembly.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
9
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
10 The program then performs post-assembly quality checking by
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
11 1) aligning each EST sequence to its corresponding unigene sequence to identify mis-assemblies; and
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
12 2) performing all-verus-all pair-wise sequence alignments of unigenes to identify sequences derived from same transcripts that fail to be assembled together.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
13
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
14 The identified mis-assemblies are then corrected by the program automatically.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
15
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
16 http://bioinfo.bti.cornell.edu/tool/iAssembler/
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
17
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
18 Citation:
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
19 Zheng Y, Zhao L, Gao J, Fei Z. (2011) iAssembler: a package for de novo assembly of Roche-454/Sanger transcriptome sequences. BMC Bioinformatics 12:453
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
20
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
21 Galaxy XML and Perl wrapper script written by: Roger Ngo, Sam Min and Todd H. Oakley, UCSB
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
22
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
23 Included files in this package:
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
24
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
25 * iAssembler.xml - Galaxy XML tool for iAssembler 1.3
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
26 * iAssembler_wrapper.pl - Wrapper script for Galaxy XML tool
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
27 * increment.txt - File required by iAssembler_wrapper.pl
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
28 * iAssembler_README - Documentation file
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
29
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
30 Note: iAssembler.pl MUST BE modified in lines 254-258 due to a bug preventing the program from working in the Galaxy platform.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
31
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
32 Pre-Installation:
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
33
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
34 iAssembler 1.3 must be installed on the Galaxy user account. In order for the Galaxy tool wrapper to work, the iAssembler.pl
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
35 script must be modified on lines 254-258.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
36
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
37 FROM:
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
38
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
39 my $version_file = $working_dir."/mira_version";
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
40 system("$program_bin_dir/mira | head > $version_file");
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
41
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
42 TO:
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
43
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
44 my $version_file = $working_dir."/mira_version";
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
45 system("$program_bin_dir/mira > $working_dir/out");
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
46 system("head $working_dir/out > $version_file");
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
47
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
48
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
49 Installation Instructions:
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
50
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
51 1. Copy the iAssembler folder to a directory in your Galaxy user account.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
52
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
53 2. Copy iAssembler.xml, iAssembler_wrapper.pl and increment.txt to a folder in /galaxy-dist/tools/
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
54
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
55 Note: increment.txt and iAssembler_wrapper.pl MUST be in the same directory.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
56
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
57 3. In iAssembler_wrapper.pl, modify the $iAssemblerBinPath to point to the iAssembler 1.3 directory in your
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
58 Galaxy user account and $iAssemblerToolPath to the path of the wrapper.
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
59
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
60 By default they have already been assigned as:
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
61
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
62 my $iAssemblerBinPath = '/labdata/nfs/galaxy/pkgs/iAssembler';
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
63 my $iAssemblerToolPath = '/labdata/nfs/galaxy/galaxy-dist/tools/iAssembler';
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
64
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
65 4. Add the Galaxy tool information to tool_conf.xml in /galaxy-dist/
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
66
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
67 5. Restart Galaxy using
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
68
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
69 ./run.sh --stop-daemon
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
70
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
71 and then
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
72
cfe16849421e iAssembler readme uploaded
rogerngo
parents:
diff changeset
73 ./run.sh --reload --daemon