ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
Revision: 1.2
Committed: Wed Dec 13 12:38:48 2006 UTC (9 years, 4 months ago) by gawi79
Branch: MAIN
Changes since 1.1: +1 -1 lines
Log Message:
Corrected spelling

Line File contents
1 <HTML>
2 <HEAD>
3 <TITLE>QuickMine manual</TITLE>
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5 <link rel="stylesheet" href="quickmineoutput.css" type="text/css">
6 </HEAD>
8 <!--<BODY bgcolor="#FFFFCC">-->
9 <body style='background-color:#FF6633;'>
10 <table align="center" style='border:solid;border-width:2px;border-color:navy;background-color:#FFFFCC'>
11 <tr><td>
14 <table border="2" cellspacing="2" cellpadding="2" bgcolor="#FFFFFF">
15 <tr valign="middle">
16 <td width="90%"><span class="quickminetitle">QuickMine manual</span> </td>
17 <td width="10%"><img src="construction.jpeg"></td>
18 </tr>
19 </table>
22 <a name="index"></a>
24 <UL>
25 <li><a href="#intro">Introduction</a>
26 <li><a href="#quickmine">Using QuickMine</a></li>
27 <ul>
28 <LI><A HREF="#input">Input files</A></LI>
29 <LI><A HREF="#self">Self-BLAST or Database BLAST</A></LI>
30 <LI><A HREF="#pipeline">QuickMine Pipeline</A></LI>
31 <LI><A HREF="#config">Configuration</A></LI>
32 <LI><A HREF="#require">Requirements</A></LI>
33 </ul>
34 <li><a href="#yamap">YAMAP interface</a></li>
35 <ul>
36 <li><A HREF="#basic">Basic</A></li>
37 <li><A HREF="#advanced">Advanced</A></li>
40 </UL>
41 </ul>
42 <li><a href="#other_things">Other information</a>.
43 <ul>
44 <LI><A HREF="#bugs">Bug reporting/known bugs</A></LI>
45 <LI><A HREF="#convert">File conversion/handling</A></LI>
46 </ul>
48 </UL>
49 <!-- INDEX END -->
51 <hr>
52 <font color="green">
53 <center>
54 <h1><a name="intro">Introduction</h1>
55 </center>
56 </font>
57 <p>QuickMine is a suite of Perl scripts capable of the analysis of large volumes of genomic data. It has been written to interrogate such data to find genomic features of interest, with particular emphasis on lineage specific genes, including 'orphans'. The pipeline makes use of a number of external programmes including BLAST. Output is generated in HTML allowing for simple navigation of the data.
59 <center>
60 <br><a href="#index">To the top.</a>
61 </center>
62 <hr>
63 <hr>
64 <font color="green">
65 <center>
66 <h1><a name="quickmine">Using QuickMine</h1>
67 </center>
68 </font>
69 <h3><a name="input">Input files</h3>
70 <p>Input files should be in fasta format. To convert file formats <a href="">readseq</a> may be useful.
71 <p>QuickMine was developed to use files obtained from the NCBI Ref-Seq database with filenames in the format NC_000000.faa. However, most filenames are acceptable. However, there must be no white-space in the filename.
72 <p>Multiple sequence files can be selected in one QuickMine run. These files can be in DNA or Protein format and can contain one or multiple sequences, providing each sequence has a fasta header line (>).
73 <h3><a name="self">Self_BLAST or Database BLAST</h3>
74 <p>QuickMine was initially developed to compare a collection of genomes to one another, hence perform a Self-BLAST. However it is possible to use QuickMine to BLAST against any BLAST database. Choosing not to run a Self_BLAST results in some of the output files providing information of limited use (for example, the dot plots (or synteny plots)).
75 <h3><a name="pipeline">QuickMine Pipeline</h3>
76 <p>The QuickMine pipeline consists of 18 perl scripts and 1 configuration file. Of the 18 scripts, there are 17 scripts involved in processing data, the other regulates the execution of 17 processing scripts The perl script is responsible for running the processing scripts. It is also responsible for generating data required for the other scripts to run and executes the BLAST searches. This script obtains all the variables from the configuration file. These values are then used to determine which sections of the pipeline need to be run and also provide the parameters required by the processing scripts. The QuickMine pipeline can be broadly split up into four groups:<br>
77 1. Pre-processing<br>
78 2. BLASTing<br>
79 3. Parsing<br>
80 4. Plotting<br>
82 <p><h4>Pre-Processing</h4>The Perl script is responsible for formatting the sequence files ready for the scripts further down the pipeline to utilise. This simply involves adding a unique identifier to the start of the FASTA header. The files produced by the script are used to generate the self BLAST database. If the value of the write_fasta_files parameter obtained from the configuration file is equal to 1, will generate a fasta file for each sequence. The script will then generate a web interface (QM.html) allowing users access to each fasta file.<br><br> If a self BLAST database is required, performs a system call, prompting the execution of formatdb using the parameters provided in the configuration file. Formatdb is a program for formatting BLAST databases from either FASTA or ASN.1 formats, in this case it formats our SELF_blast_Database FASTA file.
84 <p><h4>BLASTing</h4> initiates all the BLAST searches when running the entire QuickMine pipeline on a local machine. The parameters used in the BLAST search are determined by the user input in the configuration file. An alternative is to stop the pipeline at this point and use Condor for performing the computationally intensive BLAST searches. The script is available for creating a Condor submission file. Once Condor has finished its jobs, the pipeline can be started again from the first script in the parsing group.<br><br> It may be possible that the user has access to a Grid system. If this is the case, the script is available for creating a Condor submission file that submits jobs to the Globus universe. <br><br>If you are running QuickMine through YAMAP, currently you have to run the jobs locally.
86 <p><h4>Parsing</h4>This section of the pipeline accounts for the majority of the Perl scripts and creates the majority of the human readable output in HTML.<br><br> The first script in this section is called This script utilises the BioPerl module Bio::SearchIO to parse through the BLAST reports. generates five HTML files for each input file. The overview.html file is possibly the most important file created. It constitutes a matrix in which each row represents a sequence from the relevant input file and each column represents a different input file (in the case of a Self-BLAST). The numerical values in the elements of the matrix XY indicate the number of sequences in the input file represented by column Y that possess significant similarity to the sequence in row X. The final column on each row displays the total number of input files containing a match to the sequence. This overview file is the input of several scripts further down the pipeline.<br><br>N.B. If running against another database rather than as a Self-BLAST, there will be a single column headed '.*'. This column represents the whole database and thus merely shows the number of hits a sequence has against the database.<br><br>The second output file, matrix.html, has the same matrix format as overview.html. However, in this file, element XY shows the best hit (the sequence with the most significant match), from the input file represented by column Y to the sequence in row X.<br><br> The third output file, rank.html, lists the sequences in the relevant input file and shows the top hits from each other input file in rank order. <br><br>The overview.html, matrix.html and rank.html files all provide a link to each sequence's BLAST report.<br><br> The fourth output file, scores.html, lists the all the hits and the e-value of each hit to each sequence. The final file, tophit.html, lists the top hit to each sequence.<br><br> In some cases, there may be 100,000's of BLAST reports to parse; hence can take a long time to run. An alternative to running as part of the pipeline is to run it on Condor. The script is available for creating a suitable Condor submission file. Once has been run on each file, the QuickMine pipeline can be restarted from the next script. <br><br>If you are running QuickMine through YAMAP, currently you have to run the jobs locally.<br><br>
88 produces a hits.html file for each input file. The hits.hmtl file contains a list of all the input files that the relevant query file was compared against and displays the number of sequences in the query file that hit each other file. It displays this value as a percentage of total sequences. It also displays the number of total hits i.e. some sequence may hit more than one sequence in a particular file.<br><br>
90 parses through the overview.html output files to determine which sequences do not have significant similarity to any sequence in a different input file. It lists these orphan genes in orphan_list.html files and provides a summary of the number and percentage of orphans in each file analysed in orphan_count.html.<br><br>
92 produces orphan_size.html and orphan.faa.complete files. The BioPerl module Bio::SeqIO is used by to parse through the .faa.complete files and search for the orphans listed in the orphan_list.html files. Once identified, their sequence is printed out to the orphan.faa.complete files and the number of amino acids are counted. If an orphan sequence contains less than 150 amino acids, it is deemed to be a short orphan. If the sequence contains 150 amino acids or greater, it is classed as a long orphan. The number of each class is counted up for each file and the average orphan size is calculated. This information is printed to the orphan_size.html file.<br><br>
94 produces paralogous_orphans.html and paralogue_count.html. Paralogous_orphans.html lists the orphan genes in each input file that have significant similarity to another sequence in the same file and displays the number of sequences it is significantly similar to. Paralogue_count.html provides a summary, listing the number of paralogous orphans there are in each input file. <br><br>
96 parses through the overview.html output files to generate orphan_increment.html files. These files show the same matrix as the overview.html files, however it has an additional indicator column for each input file. This column indicates whether the relevant sequence is still considered to be an orphan i.e. does not possess a significant hit to any sequences in this input file or any of the preceding files. If a hit has been found, the indicator column will contain an N, if not it will contain a Y. Once a hit is found, the indicator columns will all be set to N for the remainder of the row. The script uses the orphan_increment.html files to generate orphan_time.html. This file contains a matrix. Each row and each column represents an input file. The number in the element XY3 represents the number of orphans in the input file in row X, after being BLASTed against the file in column Y3 and also the files in columns Y2 and Y1. Thus the matrix provides data illustrating the change in orphan number in each input file as more files are added to the comparison.<br><br>
98 simply converts all the values in overview.html files to a 0 (no hits) or a 1 (hit at least one sequence in the respective file).
100 <p><h4>Plotting</h4>All the scripts written to generate plots utilise gnuplot. generates a plot for each input file describing the change in orphan number as more input files are included in the analysis. It obtains the data from orphan_time.html. In order to produce the plot, several output files are generated. Gene_plotter_commands.dat contains the gnuplot commands necessary for generating the desired plot. Gene_plotter.dat contains the data in a format that can be read by gnuplot. Gnuplot creates the plot in png format. uses a system call to convert png to jpeg. Finally it generates orphan_plot.html to display the jpeg image. is identical to genome_plot except it converts the data in orphan_time.html to a percentage of total sequences in each file.<br><br>
102 and are very similar to and However, instead of generating a plot for each input file, it generates a single plot displaying a line for each input file. <br><br>
104 utilises the data in matrix.html to produce a dot plot for each input file against every other input file. Such plots can give an indication of how closely related two input files are and can be useful in finding regions of inversion in closely related sequences. As in the other plotting scripts, it produces a data file, a command file, a png file, a jpeg image and a HTML file. As different output files are created for every combination of input files, it is very easy to accumulate a large number of output files very quickly. Therefore it is recommended that this option is used sparingly. <br><br>
106 The final script in the pipeline is This script generates index.html. This will be loaded by web browsers when viewing the output directory. generates a list of all the HTML files created in the QuickMine pipeline, it prints this list and links to each one to the file index.html. Thus it provides an easy and simple method for the user to navigate through their results.
107 <center>
108 <br><a href="#index">To the top.</a>
109 </center>
110 <h3><a name="config">Configuration</h3>
111 <p>QuickMine utilises a configuration file. This file contains all the arguments required to perform the whole QuickMine analysis. By modifying the config file, you can select which section of the pipeline to run. It is also contains the paths to the input files and the path to the output directory. The config file also contains information such as the command used to format the BLAST database.
113 It is written in a simple format and is easily extendable. QuickMine reads the file by utilising the Config::Simple perl module.
114 <center>
115 <br><a href="#index">To the top.</a>
116 </center>
117 <h3><a name="require">Requirements</h3>
118 <p>There are two types of dependency required by QuickMine: Perl modules, and external programs.
120 <h4>Perl modules</h4>
121 <p>All of the following must be installed for all the scripts to work properly:
123 <ul>
124 <li><a href="">BioPerl</a>.
125 <li><a href="">Config::Simple</a>.
126 <li><a href="">Getopt::Std</a>.
127 </ul>
129 <p>More information on installing Perl modules can be found at <a href="">CPAN</a>. However, many of them will be installed as standard with Perl 5.8.3 (if so, <b>man</b> or <b>Perldoc</b> should provide information).
131 <h4>External programs</h4>
132 <p>The following external applications are used by msatfinder:
134 <ul>
135 <li><a href="">BLAST</a>.
136 <li><a href="">Gnuplot</a>.
137 </ul><center>
138 <br><a href="#index">To the top.</a>
139 </center>
140 <hr>
141 <hr>
142 <font color="green">
143 <center>
144 <h1><a name="yamap">The YAMAP interface</h1>
145 </center>
146 </font>
147 <p>QuickMine has been integrated into the YAMAP graphical interface. This makes it a much easier process to run QuickMine. Firstly you must choose whether to run a Self_BLAST or a Database BLAST. These must be configured by selecting the relevant 'Configure' button. Select the significance value for the QuickMine parser scripts, any database hit not within this threshold will be ignored by QuickMine. The next step involves selecting to run with Basic default options or by using more Advanced options.
148 <h3><a name="basic">Basic</h3>
149 <p>Selecting to run QuickMine using default settings is the simplest method for users to generate output. By default, QuickMine will run the first sections of the pipeline. It will parse the input files, performs the BLASTs and produce summary output files in HTML. It won't perform orphan analyses and won't perform any plotting functions.
150 <h3><a name="advanced">Advanced</h3>
151 <p>Selecting to run QuickMine with advanced settings permits you to select whether or not to run the different parts of the pipeline. For example if you have already performed the parsing of the input files and BLASTing stages and you just want to use QuickMine to parse the BLAST reports. Simply by clicking on the relevant check buttons allows you to turn on and off sections of the pipeline.<br><br>
152 However, choosing to run QuickMine in this form is prone to error. If in doubt please use the Basic settings.<br<br>
153 <br><center><a href="#index">To the top.</a>
154 </center>
155 <hr>
156 <hr>
157 <font color="green">
158 <center>
159 <h1><a name="other_things">Other Information</h1>
160 </center>
161 </font>
162 <h2><a name="bugs">Bug reporting/known bugs</a></h2>
163 <p>Though we are using this software successfully, there's a chance of bugs turning up somewhere. Should you find any, please contact us (details below) and we will attempt to squash them. If you're using QuickMine, there are a few things that you ought to bear in mind.
164 <ul>
165 <li>The most reliable method of performing a complete QuickMine run is by using YAMAP and the default settings.
166 <li>The more data you have as input the more time it will take for QuickMine to run. Both performing the BLASTs and parsing through the BLAST reports is particularly time-consuming.
167 <li>QuickMine was originally developed for use with complete bacterial proteomes and a SELF-BLAST database. Therefore, depending on your input, some of the output files may be of no worth to your particular analysis.
168 </ul>
170 <p>We welcome suggestions for new features or other improvements.
172 <h2><a name="convert">File conversion/handling methods</a></h2>
173 <p>For converting files you could use <a href="">Seqret</a> (from <a href="">EMBOSS</a>), or use <a href="">readseq</a>.
174 <br><center><a href="#index">To the top.</a>
175 </center>
176 </td></tr>
177 </body>
178 </html>