Changes for Feb 2016 SLS course
[jalview-manual.git] / TheJalviewTutorial.tex
1 %\documentclass[a4paper,11pt]{report}
2 \documentclass[a4paper,11pt]{book}
3 \usepackage[format=hang,margin=10pt]{caption}
4 \usepackage{footnote}
5 \usepackage{graphicx}
6 \usepackage{fouriernc}
7 %\usepackage{amssymb}
8 \usepackage{epstopdf}
9 \usepackage{hyperref}
10 \usepackage{subfigure}
11 \DeclareGraphicsRule{.tif}{png}{.png}{`convert #1 `dirname #1`/`basename #1 .tif`.png}
12 \voffset = -0.5 in
13 \hoffset = -0.85 in
14 \textwidth = 6.5 in 
15 \textheight = 9.5 in 
16 \oddsidemargin = 1.20 in
17 \evensidemargin = 0.2 in
18 \topmargin = 0.0 in 
19 \headheight = 0.35 in
20 \headsep = 0.4 in
21 %\headheight = 0.0 in \headsep = 0.0 in
22 \parskip = 0.2in \parindent = 0.0in
23
24
25 \newtheorem{theorem}{Theorem}
26 \newtheorem{corollary}[theorem]{Corollary}
27 \newtheorem{definition}{Definition}
28
29
30 \title{Jalview 2.5: A manual and introductory tutorial }
31 \author{David Martin, James Procter, Andrew Waterhouse, Saif Shehata, Nancy Giang,Suzanne Duce and Geoff Barton}
32 \date{Manual version 1.2.3 6th May 2011}
33
34 \newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}}\cleardoublepage}
35
36 % how the hell do we add another panel with text like : This tutorial introduces
37 % the user to the features of Jalview, a multiple sequence alignment editor and
38 % viewer available from http://www.jalview.org to the title page.
39
40 % \renewcommand{menustyle}{\tt} %do something more advanced here.
41
42 \newcounter{ecount} 
43 \newcounter{exstep}[ecount]
44 \renewcommand{\theecount} {\arabic{ecount}}
45 \renewcommand{\theexstep} {\arabic{ecount}.\alph{exstep}}
46
47 \newcommand{\exercise}[2] { 
48 \refstepcounter{ecount}
49 \begin{center} \fbox{\parbox[b][\height]{6in}{ 
50 {\bf
51 % this doesn't work - page refs are off 
52 %  \mbox{\addcontentsline{toc}{subsection}{ Exercise \theecount : #1 } }
53 Exercise \theecount  :  #1  } 
54 \par #2 }} \end{center}
55 \pagebreak[0]
56 }
57 \newcommand{\exstep}[1]{ \stepcounter{exstep} {\sl \theexstep.}  \begin{minipage}[t]{5.5in} #1 \end{minipage} \par \vspace *{1mm} }
58 %%% Remove the % on the next 2 lines to hide tutorials.
59 %\renewcommand{\exercise}[2]{} 
60 %\renewcommand{\exstep}[1]{} 
61
62 \begin{document}
63
64
65 \pagenumbering{}
66
67 %\maketitle
68 % we make our own title because JBP is not clever enough to work out how
69 % to
70 % do
71 % this automatically
72
73 \begin{center}
74
75 {\Huge
76  
77 Jalview 2.9.0b2}
78 \vspace{0.5in}
79 {\huge 
80
81 Manual and  Introductory Tutorial }
82
83 \vspace{2.4in}
84
85 {\large
86
87 David Martin, James Procter, Andrew Waterhouse, Saif Shehata, Nancy Giang,
88
89
90 Suzanne Duce and Geoff Barton
91  
92
93 }
94
95 \vspace{1.2in}
96
97 College of Life Sciences, University of Dundee
98
99 Dundee, Scotland DD1 5EH, UK
100
101
102 \vspace{2in}
103
104 Manual Version 1.6 
105 % post CLS lifesci course on 15th January
106 % draft. Remaining items are AACon, RNA visualization/editing and Protein disorder analysis exercises.
107
108 18th February 2016
109
110
111 \end{center}
112
113 %\newpage
114
115 \clearemptydoublepage
116
117 % ($Revision$) 11th October 2010.}
118 % TODO revise for 2.6
119
120 \pagenumbering{roman}
121 \setcounter{page}{1}
122 \tableofcontents 
123 %\clearemptydoublepage
124 % \listoffigures 
125 % \newpage
126 % \listoftables 
127 \newpage
128 \pagenumbering{arabic}
129 \setcounter{page}{1}
130 \chapter{Basics}
131 \label{jalviewbasics}
132 \section{Introduction}
133 \subsection{Jalview}
134 Jalview is a multiple sequence alignment viewer, editor and analysis tool.
135 Jalview is designed to be platform independent (running on Mac, MS Windows, Linux
136 and any other platforms that support Java). Jalview is capable of editing and
137 analysing large alignments (thousands of sequences) with minimal degradation in
138 performance, and able to show multiple integrated views of the alignment and
139 other data. Jalview can read and write many common sequence formats including
140 FASTA, Clustal, MSF(GCG) and PIR.
141
142
143 There are two types of Jalview program. The {\bf Jalview Desktop} is a standalone 
144 application that provides powerful editing, visualization, annotation and
145 analysis capabilities. The {\bf JalviewLite} applet has the same core
146 visualization, editing and analysis capabilities as the desktop, without the
147 desktop's webservice and figure generation capabilities. It is designed to be
148 embedded in a web page,\footnote{A demonstration version of Jalview (Jalview Micro
149 Edition) also runs on a mobile phone but the functionality is limited to sequence
150 colouring.} and includes a javascript API to allow customisable display of
151 alignments for web sites such as Pfam.\footnote{\url{http://pfam.xfam.org}}
152
153
154 Jalview 2.8.2 was released in December 2014. The Jalview Desktop in this version
155 provides access to protein and nucleic acid sequence, alignment and structure
156 databases, and includes the Jmol\footnote{ Provided under the LGPL licence at
157 \url{http://www.jmol.org}} viewer for molecular structures, and the VARNA\footnote{Provided under GPL licence at \url{http://varna.lri.fr}} program for the visualization of RNA secondary structure. A
158 Distributed Annotation System (DAS) client\footnote{jDAS - released under Apache license (v2.0) at \url{http://code.google.com/p/jdas}} which facilitates the retrieval and display of third party sequence
159 annotation in association with sequences and any associated structure. It also
160 provides a graphical user interface for the multiple sequence alignment, conservation analysis and protein disorder prediction methods provided as {\bf Ja}va {\bf B}ioinformatics
161 {\bf A}nalysis {\bf W}eb {\bf S}ervices (JABAWS). JABAWS\footnote{released under GPL at \url{http://www.compbio.dundee.ac.uk/jabaws}} is a system for running bioinformatics programs that you can download and run on your own machine or cluster, or install on compute clouds.
162
163 \subsection{Jalview's Capabilities}
164 % TODO add references to appropriate sections for each capability described here.
165 Figure \ref{jvcapabilities} gives an overview of the main features of the
166 Jalview desktop application. Its primary function is the editing and
167 visualization of sequence alignments, and their interactive analysis. Tree
168 building, principal components analysis, physico-chemical property conservation
169 and sequence consensus analyses are built into the program. Web services enable
170 Jalview to access online alignment and secondary structure prediction programs,
171 as well as to retrieve protein and nucleic acid sequences, alignments, protein structures and sequence annotation. Sequences, alignments, trees, structures, features and alignment annotation may also be exchanged with the local filesystem. Multiple visualizations of an alignment may be worked on simultaneously, and the user interface provides a comprehensive set of controls for colouring and layout. Alignment views are dynamically linked with Jmol structure displays, a tree viewer and spatial cluster display, facilitating interactive exploration of the alignment's structure. The application provides its own Jalview project file format in order to store the current state of an alignment and analysis windows. Jalview also provides WYSIWIG\footnote{WYSIWIG: What You See Is What You Get.} style figure generation capabilities for the preparation of alignments for publication.
172 \begin{figure}[htbp]
173 \begin{center}
174 \includegraphics[width=5.8in]{images/jvcapabilities.pdf}
175 \caption{{\bf Capabilities of the Jalview Desktop.} The Jalview Desktop Application provides a stable environment for the creation, editing and analysis of alignments and the generation of figures.}
176 \label{jvcapabilities}
177 \end{center}
178 \end{figure}
179
180 \subsubsection{Jalview History}
181 Jalview was initially developed in 1996 by Michele Clamp, James Cuff, Steve
182 Searle and Geoff Barton at the University of Oxford and then the European
183 Bioinformatics Institute. Development of Jalview 2 was made possible with
184 eScience funding from the BBSRC\footnote{Biotechnology and Biological Sciences
185 Research Council grant  {\sl ``VAMSAS: Visualization and Analysis of Molecules,
186 Sequence Alignments and Structures"}, a joint project to enable interoperability
187 between Jalview, TOPALi and AstexViewer.} in 2004, enabling Andrew Waterhouse and
188 Jim Procter to re-engineer the original program to introduce contemporary developments
189 in bioinformatics and take advantage of the latest web and Java technology.
190 Jalview's development has been supported from 2009
191 by awards from the BBSRC's Tools and Resources fund, and, since 2014, a Wellcome Trust Biomedical Resource grant\footnote{Wellcome grant number 101651/Z/13/Z}. In 2010, 2011, and 2012, Jalview benefitted from the
192 \href{http://code.google.com/soc/}{Google Summer of Code}, when Lauren Lui and Jan Engelhardt introduced new features for handling RNA alignments and secondary structure annotation, in collaboration with Yann Ponty.\footnote{\url{http://www.lix.polytechnique.fr/~ponty/}}
193
194  
195 %TODO describe future plans in history ? not a good idea.
196 % Jalview continues to be one of the worlds most popular\footnote{and in the authors opinion, the best.} sequence alignment and analysis tools.
197
198 \subsubsection{Citing Jalview}
199 If you use Jalview in your work you should cite:\newline
200 {\sl "Jalview Version 2 - a multiple sequence alignment editor and analysis
201 workbench"}\newline Waterhouse, A.M., Procter, J.B., Martin, D.M.A, Clamp, M. and Barton, G. J. (2009) \newline {\sl Bioinformatics}  doi: 10.1093/bioinformatics/btp033
202
203 This paper supersedes the original Jalview publication:\newline {\sl "The
204 Jalview Java alignment editor"} \newline Michele Clamp, James Cuff, Stephen M. Searle and Geoffrey J. Barton (2004) \newline {\sl Bioinformatics} {\bf 20} 426-427. 
205
206   
207 \subsection{About this Tutorial }
208
209 This tutorial is written in a manual format with short exercises where
210 appropriate, typically at the end of each section. This chapter concerns the
211 basic operation of Jalview and should be sufficient for those who want to
212 load Jalview (Section \ref{startingjv}), open an alignment (Section \ref{loadingseqs}), perform basic editing and colouring (Section \ref{selectingandediting} and Section \ref{colours}), and produce publication
213 and presentation quality graphical output (Section \ref{layoutandoutput}).
214
215 Chapter \ref{analysisannotation} covers the additional visualization and
216 analysis techniques that Jalview provides. This includes working with the
217 embedded Jmol molecular structure viewer, building and viewing trees and PCA
218 plots, and using trees for sequence conservation analysis. An overview of
219 the Jalview Desktop's webservices is given in Section \ref{jvwebservices}, and
220 the alignment and secondary structure prediction services are described
221 in detail in Sections \ref{msaservices} and \ref{protsspredservices}. Following
222 this, Section \ref{featannot} details the creation and visualization of sequence
223 and alignment annotation, and the retrieval of sequences and annotation from
224 databases and DAS Servers. Finally, Section \ref{workingwithnuc} discusses
225 specific features of use when working with nucleic acid sequences, such as translation and linking to protein
226 coding regions, and the display and analysis of RNA secondary structure.
227
228 %^Chapter \ref{jalviewadvanced} The third chapter covers the detail^ of Jalview and is aimed at the user who is
229 %already familiar with Jalview operation but wants to get more out of their
230 %Jalview experience.
231
232 \subsubsection{Typographic Conventions}
233
234 Keystrokes using the special non-symbol keys are represented in the tutorial by
235 enclosing the pressed keys with square brackets ({\em e.g.} [RETURN] or [CTRL]).
236
237 Keystroke combinations are combined with a `-' symbol ({\em e.g.} [CTRL]-C means
238 press [CTRL] and the `C' key).
239
240 Menu options are given as a path from the menu
241 that contains them - for example {\sl File $\Rightarrow$ Input Alignment
242 $\Rightarrow$ From URL} means to select the `From URL' option from the `Input
243 Alignment' submenu of a window's `File' dropdown menu.
244
245 \section{Launching the Jalview Desktop Application}
246 \label{startingjv}
247 \begin{figure}[htbp]
248 \begin{center}
249 \includegraphics[width=4.5in]{images/download.pdf}
250 \caption{\bf Download page on the Jalview web site at www.jalview.org.}
251 \label{download}
252 \end{center}
253 \end{figure}
254
255 This tutorial is based on the Jalview
256 Desktop application. Much of the information will also be useful for users of
257 the JalviewLite applet, which has the same core editing, analysis and visualization capabilities (see the
258 \href{http://www.jalview.org/examples/applets.html}{JalviewLite Applet Examples}
259 page for examples). The Jalview Desktop, however, is much more powerful, and
260 includes additional support for interaction with external web services, and
261 production of publication quality graphics.
262
263 The Jalview Desktop can be run in two ways; as an application launched from the
264 web {\sl via} Java webstart, or as an application loaded onto your hard drive. 
265 The webstart version is launched from the pink `Launch Jalview Desktop
266 button' at the top right hand side of pages of the website 
267 \href{http://www.jalview.org}{(www.jalview.org)}.
268 To download the locally installable version, follow the links on the download
269 page
270 \href{http://www.jalview.org/download}{(www.jalview.org/download) }
271  (Figure \ref{download}).
272 These links will launch the latest stable release of Jalview.\par
273
274 %% this paragraph needs to be rewritten for the new signed certificate from Certum.
275
276 When the application is launched with webstart, two dialogs may appear before
277 the application starts. If your browser is not set up to handle webstart, then
278 clicking the launch link may download a file that needs to be opened
279 manually, or prompt you to select the correct program to handle the webstart
280 file. If that is the case, then you will need to locate the {\bf javaws} program
281 on your system\footnote{The file that is downloaded will have a type of {\bf
282 application/x-java-jnlp-file} or {\bf .jnlp}. The {\bf javaws} program that can run
283 this file is usually found in the {\bf bin} directory of your Java
284 installation}. Once java webstart has been launched, you may also be prompted to
285 accept a security certificate signed by the Barton Group.\footnote{On some
286 systems, the certificate may be signed by 'UNKNOWN'. In this case, clicking
287 through the dialogs to look at the detailed information about the certificate
288 should reveal it to be a Barton group certificate.} You can always trust us, so
289 click trust or accept as appropriate. The splash screen (Figure \ref{splash})
290 gives information about the version and build date that you are running,
291 information about later versions (if available), and the paper to cite in your
292 publications. This information is also available on the Jalview web site at 
293 \url{http://www.jalview.org}.
294
295 %[fig 2] 
296 \begin{figure}[htbp]
297
298 \begin{center}
299 \includegraphics[width=4.5in]{images/splash.pdf}
300 \caption{{\bf Jalview splash screen.}}
301 \label{splash}
302 \end{center}
303 \end{figure}
304
305 When Jalview starts it will automatically load an example alignment from the
306 Jalview site. This behaviour can be switched off in the Jalview Desktop
307 preferences dialog  by unchecking the open file option.
308 This alignment will look like the one in Figure \ref{startpage} (taken
309 from Jalview version 2.7).
310
311 %[figure 3 ]
312 \begin{figure}[htbp]
313 \begin{center}
314 \includegraphics[width=4in]{images/start.pdf}
315 \caption{{\bf Default startup for Jalview.}}
316 \label{startpage}
317 \end{center}
318 \end{figure}
319
320
321 \subsubsection{Jalview News RSS Feed}
322
323 Announcements are made available to users of the
324 Jalview Desktop {\sl via} the Jalview Newsreader. This window will open
325 automatically when new news is available, and can also be accessed {\sl via} the
326 Desktop's {\sl Tools $\Rightarrow$ Show Jalview News} menu entry. 
327
328 \begin{figure}[htbp]
329 \begin{center}
330 \includegraphics[height=3in]{images/jvrssnews.pdf}
331 \caption{{\bf The Jalview News Reader.} The newsreader opens automatically
332 when new articles are available from the Jalview Desktop's news channel.}
333 \label{jalviewrssnews}
334 \end{center}
335 \end{figure}
336
337
338 \exercise{Launching Jalview from the Jalview Website}{
339 \label{start}
340 \exstep{Open the Jalview web
341 site \href{http://www.jalview.org}{(www.jalview.org)}
342 in your web browser. Launch Jalview by clicking on the
343 pink `Launch Jalview' Desktop button in the top right hand corner. This
344 will download and open a jalview.jnlp webstart file.}
345 \exstep {Dialogue boxes
346 will open and ask if you want to open the jalview.jnlp file as the file is an application downloaded from the
347 Internet, click Open. (Note you maybe asked to update Java, if you agree then it
348 will automatically update the Java software). As Jalview opens, four demo
349 Jalview windows automatically load.}
350 \exstep {If
351 you are having trouble, it may help changing the browser you are using, as the browsers and
352 it's version may affect this process.}
353 \exstep{To deactivate the opening of the 4 demo sequences during the launch, go
354 to the {\sl Tools $\Rightarrow$
355 Preferences...} menu on the desktop. A `Preference'
356 dialogue box opens, untick the box adjacent to the `Open file' entry in the
357 `Visual' preferences tab.
358 Click OK to save the preferences.}
359 \exstep{Launch another Jalview workbench from the web site by clicking on the
360 pink Launch button.
361 The example alignment should not be loaded as Jalview starts up.}
362 \exstep{To reload the original demo file select the
363 {\em File$\Rightarrow$ From URL} entry in the Desktop menu. Click on
364 the URL history button on the right hand side of the dialog box to view the
365 files, select exampleFile\_2\_7.jar, then click OK.}
366 {\bf Note:} Should you want to reload the example alignment or load your own
367 sequence during the launch process, then go
368 to the {\sl Tools $\Rightarrow$
369 Preferences...} menu on the desktop. The tick the `Open file' entry of `Visual'
370 preferences tab, type in the URL of the sequence you want to load. This
371 file will load during the start up process.
372 As the jalview.jnlp file launches Jalview on your desktop, you
373 may want to move this from the downloads folder to another folder.
374 Opening from this file will allow Jalview to be launched offline.
375
376 {\bf Help launching Jalview is available in videos on the Getting Started page
377 of the Jalview website at \url{http://www.jalview.org/Help/Getting-Started}.}}
378
379 \subsection{Getting Help}
380 \label{gettinghelp}
381 \subsubsection{Built in Documentation}
382 Jalview has comprehensive on-line help documentation. Select  {\sl Help
383 $\Rightarrow$ Documentation} from the main window menu and a new window will
384 open (Figure \ref{help}). The appropriate topic can then be selected from the
385 navigation panel on the left hand side. To search for a specific topic, click
386 the `search' tab and enter keywords in the box which appears.
387
388
389 \begin{figure}[htbp]
390 \begin{center}
391 \parbox[c]{2in}{\centerline{\includegraphics[width=2.75in]{images/help1.pdf}}}
392 \parbox[c]{4in}{\includegraphics[width=4in]{images/help2.pdf}}
393 \caption{{\bf Accessing the built in Jalview documentation.}}
394 \label{help}
395 \end{center}
396 \end{figure}
397
398 \subsubsection{Email Lists}
399
400 The Jalview Discussion list {\tt jalview-discuss@jalview.org} provides a forum
401 for Jalview users and developers to raise problems and exchange ideas - any
402 problems, bugs, and requests for help should be raised here. The {\tt
403 jalview-announce@jalview.org} list can also be subscribed to if you wish to be
404 kept informed of new releases and developments. 
405
406 Archives and mailing list
407 subscription details can be found in the Jalview web site's \href{http://www.jalview.org/community}{community section}.
408
409 \section{Navigation}
410 \label{jvnavigation}
411 The major features of the Jalview Desktop are illustrated in Figure \ref{anatomy}. The alignment window is the primary window for editing and visualization, and can contain several independent views of the alignment being worked with. The other windows (Trees, Structures, PCA plots, etc) are linked to a specific alignment view. Each area of the alignment window has a separate context menu accessed by clicking the right mouse button.  
412
413  Jalview has two navigation and editing modes: {\bf normal mode}, where
414  editing and navigation is performed using the mouse, and {\bf cursor mode}
415  where editing and navigation are performed using the keyboard. The {\bf F2 key}
416  is used to switch between these two modes. With a Mac as the F2 is
417  often assigned to screen brightness, one may often need to  type {\bf function
418  [Fn] key with F2}.
419
420 \begin{figure}[htb]
421 \begin{center}
422 \includegraphics[width=6.5in]{images/jalview_anatomy.pdf}
423 \caption{{\bf The anatomy of Jalview.} The major features of the Jalview Desktop Application are labeled.}
424 % TODO: modify text labels to be clearer - black on grey and black border for clarity
425 \label{anatomy}
426 \end{center}
427 \end{figure}
428
429 \subsection{Navigation in Normal Mode}
430
431 Jalview always starts up in Normal mode, where the mouse is used to interact
432 with the displayed alignment view. You can move about the alignment by clicking
433 and dragging the ruler scroll bar to move horizontally, or by clicking and
434 dragging the alignment scroll bar to the right of the alignment to move
435 vertically.  If all the rows or columns in the alignment are displayed, the
436 scroll bars will not be visible.
437
438  Each alignment view shown in the alignment window presents a window onto the
439  visible regions of the alignment. This means that with anything more than a few
440  residues or sequences, alignments can become difficult to visualize on the
441  screen because only a small area can be shown at a time. It can help,
442  especially when examining a large alignment, to have an overview of the whole
443  alignment. Select {\sl View $\Rightarrow$ Overview Window} from the Alignment
444  window menu bar (Figure \ref{overview}\footnote{the menu shown in this figure
445  is from Jalview 2.2, later versions have more options.}).
446 % (Figure4)
447 \begin{figure}[htbp]
448 \begin{center}
449 \includegraphics[width=4.5in]{images/overview.pdf}
450 \caption{{\bf Alignment Overview Window.} The overview window for a view is opened from the {\em View} menu.}
451 \label{overview}
452 \end{center}
453 \end{figure}
454
455 The red box in the overview window shows the current view in the alignment
456 window. A percent identity histogram is plotted below the alignment overview.
457 Shaded parts indicate rows and columns of the alignment that are hidden (in this
458 case, a single row at the bottom of the alignment - see Section
459 \ref{hidingregions}). You can navigate around the alignment by dragging the red
460 box. 
461
462 %Try this now and see how the view in the alignment window changes.
463
464 \parbox[c]{3in}{Alignment and analysis windows are closed by clicking on the
465 usual `close' icon (indicated by arrows on Mac OS X). If you want to close all
466 the alignments and analysis windows at once, then use the {\sl Window
467 $\Rightarrow$ Close All} option from the Jalview desktop.
468
469 {\bf \em{Warning: make sure you have saved your work because this cannot be
470 undone!}} }
471 \parbox[c]{3in}{\centerline{\includegraphics[width=2.5in]{images/start_closeall.pdf}
472 }}
473
474 \subsection{Navigation in Cursor Mode}
475 \label{cursormode}
476 \parbox[c]{5in}{Cursor mode navigation enables the user to quickly
477 and precisely navigate, select and edit parts of an alignment. On pressing F2 to
478 enter cursor mode the position of the cursor is indicated by a black background
479 and white text. The cursor can be placed using the mouse or moved by pressing
480 the arrow keys ($\uparrow$, $\downarrow$, $\leftarrow$, $\rightarrow$).
481 }\parbox[c]{1.25in}{\centerline{\includegraphics[width=0.8in]{images/cursor1.pdf}}}
482
483 Rapid movement to specific positions is accomplished as listed below:
484 \begin{list}{$\circ$}{}
485 \item {\bf Jump to Sequence {\sl n}:} Type a number {\sl n} then press [S] to
486 move to sequence (row). {\sl n}
487 \item {\bf Jump to Column {\sl n}:} Type a number {\sl n} then press [C] to move to column {\sl n} in the alignment.  
488 \item {\bf Jump to Residue {\sl n}:} Type a number {\sl n} then press [P] to move to residue number {\sl n} in the current sequence.  
489 \item {\bf Jump to  column {\sl m} row {\sl n}:} Type the column number {\sl m}, a comma, the row number {\sl n} and press [RETURN]. 
490 \end{list}
491 \subsection{The Find Dialog Box}
492 \label{searchfunction}
493 A further option for navigation is to use the {\sl Select $\Rightarrow$
494 Find\ldots} function. This opens a dialog box into which can be entered regular
495 expressions for searching sequences and sequence IDs, or sequence numbers.
496 Hitting the [Find next] button will highlight the first (or next) occurrence of
497 that pattern in the sequence ID panel or the alignment, and will adjust the view
498 in order to display the highlighted region. The Jalview Help provides
499 comprehensive documentation for this function, and a quick guide to the regular
500 expressions that can be used with it.
501 %TODO insert a figure for the Find dialog box
502
503 \exercise{Navigation}{
504 Jalview has two navigation and editing modes: {\bf normal} mode (where editing
505 and navigation are via the mouse) and the {\bf cursor} mode (where editing and
506 navigation are via the keyboard).
507 The {\bf F2 key} is used to switch between these two modes. With a Mac often
508 need to type function  {\bf Fn key and F2}, as button is often assigned to
509 screen brightness. Jalview always starts up in {\bf normal mode}.
510
511 \exstep{Load an example alignment from its URL
512 (\url{http://www.jalview.org/examples/exampleFile_2_7.jar}) via the Desktop
513 using {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From URL} dialog
514 box.
515 (The URL should be stored in its history and clicking on the {\sl down arrow} is
516 an easy way to access it.)}
517 \exstep{Scroll around the alignment using the alignment (vertical) and ruler (horizontal) scroll bars.}
518 \exstep{Find the Overview Window, {\sl Views
519 $\Rightarrow$ Overview Window} and open it. Move around the
520 alignment by clicking and dragging the red box in the overview window.}
521 \exstep{Return to the alignment window. Look at the status bar (lower left hand
522 corner of the alignment window) as you move the mouse over the alignment. It indicates information about the
523 sequence and residue under the cursor.}
524 \exstep{Press [F2] key (or [Fn]/[F2] on Mac) to enter {\bf Cursor mode}. Use
525 the direction keys to move the cursor around the alignment.}
526 \exstep{Move to sequence 7 by pressing {\bf 7 S}. Move to column 18 by pressing
527 {\bf 1 8 C}. Move to residue 18 by pressing {\bf 1 8 P}. Note that these can be
528 two different positions if gaps are inserted into the sequence. Move to sequence 5,
529 column 13 by typing {\bf 1 3 , 5 [RETURN]}.}
530
531 {\bf Note:} To view Jalview's comprehensive on-line help documentations select
532 Help on desktop menu, clicking on Documentation will open a Documentation
533 window. Select topic from the navigation panel on the left hand side or use the
534 Search tab to select specific key words.
535 {\bf Help navigating is available in videos on the Getting Started page
536 of the Jalview website at \url{http://www.jalview.org/Help/Getting-Started}}
537 }
538
539 \section{Loading Sequences and Alignments}
540 \label{loadingseqs}
541 %Jalview provides many ways to load your own sequences. %For this section of the
542 % tutorial you will need to download the file http://www.jalview.org/tutorial/alignment.fa to a suitable location on your hard drive.
543 \subsection{Drag and Drop}
544         In most operating systems you can just drag a file icon from a file browser
545         window and drop it on an open Jalview application window. The file will then be opened as a new alignment window. %You can try this with the tutorial file you have downloaded. When you have opened the file, close it again by selecting the close control on the window. If you drop an alignment file onto an open alignment window it will be appended.
546         Drag and drop also works when loading data from a URL -
547 simply drag the link or url from the address panel of your browser on to an
548 alignment or the Jalview desktop background and Jalview will load data from the
549 URL directly.
550 %  (Figure \ref{drag})
551 % %[fig 5]
552 % \begin{figure}[htbp]
553 % \begin{center}
554 % \includegraphics[width=2in]{images/drag2.pdf}
555 % \includegraphics[width=2in]{images/drag3.pdf}
556 % \caption{{\bf An alignment can be opened by dragging the file onto the Jalview window. }}
557 % \label{drag}
558 % \end{center}
559 % \end{figure}
560
561 % %\includegraphics[width=2in]{images/drag1.pdf}
562
563
564 \subsection{From a File}
565 Jalview can read sequence alignments from a sequence alignment file. This is a
566 text file, not a word processor document. For entering sequences from a
567 wordprocessor document see Cut and Paste  (Section \ref{cutpaste}) below. Select
568 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the main
569 menu (Figure \ref{loadfile}). You will then get a file selection window where
570 you can choose the file to open. Remember to select the appropriate file type.
571 Jalview can automatically identify some sequence file formats.
572
573 %[fig 6]
574 \begin{figure}[htbp]
575 \begin{center}
576 \includegraphics[width=2in]{images/loadfilebox.pdf}
577 %\includegraphics[width=2in]{images/loadfilebox2.pdf}
578 \includegraphics[width=3in]{images/loadfileboxdrop.pdf}
579 \caption{{\bf Opening an alignment from a file saved on disk. }}
580 \label{loadfile}
581 \end{center}
582 \end{figure}
583
584 \subsection{From a URL}
585 Jalview can read sequence alignments directly from a URL. Please note that the
586 files must be in a sequence alignment format - an HTML alignment or graphics
587 file cannot be read by Jalview.
588 Select {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From URL} from the
589 main menu and a window will appear asking you to enter the URL (Figure
590 \ref{loadurl}). Jalview will attempt to automatically discover the file format.
591
592 %[fig 7]
593 \begin{figure}[htbp]
594 \begin{center}
595 \includegraphics[width=2in]{images/menuloadurl.pdf}
596 \includegraphics[width=3in]{images/loadurlbox.pdf}
597 \caption{{\bf Opening an alignment from a URL. }}
598 \label{loadurl}
599 \end{center}
600 \end{figure}
601
602 \subsection{Cut and Paste}
603 \label{cutpaste}
604 Documents such as those produced by Microsoft Word cannot be readily understood
605 by Jalview. The way to read sequences from these documents is to select the
606 data from the document and copy it to the clipboard. There are two ways to
607 do this. One is to right-click on the desktop background, and select the
608 `Paste to new alignment' option in the menu that appears. The other is to select
609 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox} from the
610 main menu, and paste the sequences into the textbox window that will appear
611 (Figure \ref{loadtext}). In both cases, presuming that they are in the right
612 format, Jalview will happily read them into a new alignment window.
613 %[fig 8]
614
615 \begin{figure}[htbp]
616 \begin{center}
617 \includegraphics[width=2in]{images/menuloadtext.pdf}
618 \includegraphics[width=3in]{images/loadtextbox.pdf}
619 \caption{{\bf Opening an alignment from pasted text. }}
620 \label{loadtext}
621 \end{center}
622 \end{figure}
623
624
625 \subsection{From a Public Database}
626 \label{fetchseq}
627 Jalview can retrieve sequences and sequence alignments from the public databases
628 housed at the European Bioinformatics Institute, including Uniprot, Pfam, Rfam
629 and the PDB, as well as any DAS sequence server registered at the configured DAS
630 registry. Jalview's sequence fetching capabilities allow you to avoid having to
631 manually locate and save sequences from a web page before loading them into
632 Jalview. It also allows Jalview to gather additional metadata provided by the
633 source, such as annotation and database cross-references.
634 Select {\sl File $\Rightarrow$ Fetch Sequence(s) \ldots} from the main menu and
635 a window will appear (Figure \ref{loadseq}). Pressing the database selection
636 button in the dialog box opens a new window showing all the database sources
637 Jalview can access (grouped by the type of database). Once you've selected the
638 appropriate database, hit OK close the database selection window, and then enter
639 one or several database IDs or accession numbers separated by a semicolon and
640 press OK. Jalview will then attempt to retrieve them from the chosen database.
641 Example queries are provided for some databases to test that a source is
642 operational, and can also be used as a guide for the type of accession numbers
643 understood by the source.\footnote{Most DAS sources support {\em range queries}
644 that can be used to download just a particular range from a sequence database
645 record.}
646 % [fig 9]
647 \begin{figure}[htbp]
648 \begin{center}
649 \includegraphics[width=5in]{images/fetchseq.pdf}
650 \caption{{\bf Retrieving sequences from a public database.}}
651 \label{loadseq}
652 \end{center}
653 \end{figure}
654  
655 \subsection{Memory Limits}
656 \label{memorylimits}
657 Jalview is a Java program. One unfortunate implication of this is that Jalview
658 cannot dynamically request additional memory from the operating system. It is
659 important, therefore, that you ensure that you have allocated enough memory to
660 work with your data. On most occasions, Jalview will warn you when you have
661 tried to load an alignment that is too big to fit in to memory (for instance,
662 some of the PFAM alignments are {\bf very} large). You can find out how much
663 memory is available to Jalview with the desktop window's {\sl $\Rightarrow$
664 Tools $\Rightarrow$ Show Memory Usage} function, which enables the display of
665 the currently available memory at the bottom left hand side of the Desktop
666 window's background. Should you need to increase the amount of memory available
667 to Jalview, full instructions are given in the built in documentation (opened by
668 selecting {\sl Help $\Rightarrow$ Documentation}) and on the JVM memory
669 parameters page (\url{http://www.jalview.org/jvmmemoryparams.html}).
670
671 \exercise{Loading Sequences}{
672 \label{load}
673 \exstep{Use {\sl Window $\Rightarrow$ Close All} from the Desktop window menu to
674 close all windows.}
675 \exstep{{\bf Loading sequences from URL:} Selecting File {\sl $\Rightarrow$
676 Input Alignment $\Rightarrow$ From URL} from the Desktop and enter \textsf{http://www.jalview.org/tutorial/alignment.fa} in the box.
677
678 Click OK to load the alignment.}
679 \exstep{{\bf Loading sequences from a file:} Close all windows using the
680 {\sl Window $\Rightarrow$ Close All} menu option from the Desktop.
681 Then type the same URL (\url{http://www.jalview.org/tutorial/alignment.fa}) into
682 your web browser and {\bf save} the file to your desktop.
683 Open the file you have just saved in Jalview by selecting {\sl File
684 $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the desktop menu and
685 selecting this file.
686 Click OK to load.}
687 \exstep{{\bf Loading sequences by `Drag and Drop' / `Cut and Paste':}
688
689 (i) Select {\sl Desktop $\Rightarrow$ Window
690 $\Rightarrow$ Close All}. Then drag the alignment.fa file from the desktop and
691 drop it onto the Jalview window, the alignment should open.
692
693 Test the differences
694 between (a) dragging the sequence onto the Jalview desktop  and (b)
695 dragging the sequence onto an existing alignment window.
696
697 (ii) Open \url{http://www.jalview.org/tutorial/alignment.fa} in a
698 web browser. Drag the URL directly from browser onto Jalview desktop. (If
699 the URL is downloaded, then locate the file in your
700 download directory and open it in a text editor.)
701
702 (iii) Open the alignment.fa file using text editor. Copy the sequence text from the
703 file into the clipboard and paste it into the desktop
704 background by right-clicking and selecting Paste to new alignment option.
705
706 (iv) In the text editor, copy the sequence text from
707 alignment.fa  into the clipboard (usually {\sl via} the browser's {\sl Edit
708 $\Rightarrow$ Copy} menu option). In the Desktop menu, select {\sl File
709 $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox}.
710 Paste the clipboard into the large window using the {\sl Edit $\Rightarrow$
711 Paste} text box menu option. Click {\sl New Window} and the alignment will be
712 loaded.}
713 \exstep{{\bf Loading sequences from Public Database:} Select {\sl File
714 $\Rightarrow$ Fetch Sequence(s)...} from the Desktop to open up new window
715 called New Sequence Fetcher.
716 Press database selection button (top of the dialog box), this opens
717 another window called Select Database Retrieval Source showing all the database
718 sources.
719
720 Select the {\bf PFAM seed} database and click OK, then enter the accession
721 number {\bf PF03460} and click OK. An alignment of about 174 sequences should
722 load. These can be viewed using the Overview window accessible from {\sl View
723 $\Rightarrow$ Overview Window.}
724 Several database IDs can be loaded by using semicolons to separate them.}
725 {\bf Help loading sequences is available in videos on the Getting Started page
726 of the Jalview website at \url{http://www.jalview.org/Help/Getting-Started}.}
727 }
728
729 \section{Saving Sequences and Alignments}
730 \label{savingalignments} 
731 \subsection{Saving Alignments} Jalview allows the
732 current sequence alignments to be saved to file so they can be restored at a
733 later date, passed to colleagues or analysed in other programs. From the
734 alignment window menu select {\sl File $\Rightarrow$ Save As} and a dialog box
735 will appear (Figure \ref{savealign}). You can navigate to an appropriate
736 directory in which to save the alignment. Jalview will remember the last filename
737 and format used to save (or load) the alignment, enabling you to quickly save
738 the file during or after editing by using the {\sl File $\Rightarrow$ Save} entry.
739
740 Jalview offers several different formats in which an alignment can be saved. The
741 jalview format (.jar) is the only format which will preserve the colours,
742 groupings and other additional information in the alignment. The other formats
743 produce text files containing just the sequences with no visualization information, although some
744 allow limited annotation and sequence features to be stored (e.g. AMSA).
745 Unfortunately only Jalview program can read Jalview files. The {\sl File
746 $\Rightarrow$ Output To Textbox} menu option allows the alignment to be copied and pasted into
747 other documents or web servers.
748
749 %[fig 10]
750 \begin{figure}[htbp]
751 \begin{center}
752 \parbox[c]{1.0in}{
753 \includegraphics[width=1.0in]{images/saveas.pdf}
754 }
755 \parbox[c]{4in}{
756 \includegraphics[width=4in]{images/saveas2.pdf}
757 }
758 \caption{{\bf Saving alignments in Jalview to disk.}}
759 \label{savealign}
760 \end{center}
761 \end{figure}
762
763 \subsection{Jalview Projects}
764 \parbox[c]{4in}{If you wish to save a complete Jalview session rather than
765 just a single alignment (e.g. because you have calculated trees or multiple
766 different alignments) then save your work as a Jalview Project
767 file (.jvp).\footnote{Tip: Ensure that you have allocated plenty of memory to
768 Jalview when working with large alignments in Jalview projects. See Section \protect
769 \ref{memorylimits} above for how to do this.}
770 From the main menu select {\sl File $\Rightarrow$ Save Project} and a file save
771 dialog box will appear. Loading a project will restore Jalview to exactly the
772 view at which the file was saved, complete with all alignments, trees,
773 annotation and displayed structures rendered appropriately.
774 } \parbox[c]{2in}{ \centerline {
775 \includegraphics[width=1.5in]{images/saveproj.pdf} }}
776
777 \exercise{Saving Alignments}{
778 \label{save}
779 \exstep{Launch Jalview, or use close all windows.
780 Load the ferredoxin
781 alignment from PFAM (seed) data base using the PFAM seed accession number
782 PF03460 (see Exercise \ref{load}). } \exstep{
783
784 Select {\sl File $\Rightarrow$ Save As} from the alignment window menu. Choose a
785 location into which to save the alignment and select your preferred format. All
786 formats except {\sl  Jalview } jvp can be viewed in a normal text editor (e.g.
787 Notepad) or in a web browser.
788 Enter a file name and click {\sl Save}.
789
790 Check this file by closing all windows and opening it with Jalview, or by
791 browsing to it with your web browser.}
792 \exstep{ Repeat the previous step saving the files in different file formats.}
793 \exstep{Select {\sl File $\Rightarrow$ Output to Textbox $\Rightarrow$ FASTA}.
794 Select and copy this alignment to the clipboard using the textbox menu options
795 {\sl Edit $\Rightarrow$ Select All} followed by {\sl Edit $\Rightarrow$ Copy}.
796 The alignment can then be pasted into any application of choice, e.g. a word processor or web form.
797 }
798 \exstep{Ensure at least one alignment window is active in Jalview. Open the
799 overview window {\sl View $\Rightarrow$ Overview Window}
800  and scroll red box to any part of the alignment.
801 Select {\sl File
802 $\Rightarrow$ Save Project} from the main menu and save the project in a
803 suitable folder.
804
805 Close all windows and then load the project {\sl via} the {\sl File
806 $\Rightarrow$ Load Project} menu option. Observe how all the windows and
807 positions are exactly as they were when they were saved. } 
808 {\bf Help saving sequences is available in videos on the Getting Started page
809 of the Jalview website at \url{http://www.jalview.org/Help/Getting-Started}.}}
810
811
812 \chapter{Selecting and Editing Sequences }
813 \label{jalviewediting}
814
815 \label{selectingandediting} 
816 Jalview makes extensive use of selections - most of the commands available from
817 its menus operate on the {\sl currently selected region} of the alignment, either to
818 change their appearance or perform some kind of analysis. This section
819 illustrates how to make and use selections and groups.
820
821 \section{Selecting Parts of an Alignment}
822 Selections can be of arbitrary regions in an alignment, one or more complete columns, or one or 
823 more complete sequences.
824 A selected region can be copied and pasted as a new alignment 
825 using the {\sl Edit $\Rightarrow$ Copy} and {\sl Edit $\Rightarrow$ Paste $\Rightarrow$ To New 
826 Alignment}  in the alignment window menu options.
827 {\bf To clear (unselect)  the selection press the [ESC] (escape) key.}
828
829 \subsection{Selecting Arbitrary Regions}
830 To select part of an alignment, place the mouse at the top left corner of the region you wish to select. Press and hold the mouse button and drag the mouse to the bottom right corner of the chosen region then release the mouse button. A dashed red box appears around the selected region (Figure \ref{select}). 
831 %[fig 12]
832
833 \begin{figure}[htbp]
834 \begin{center}
835 \includegraphics[width=4in]{images/select1.pdf}
836 \caption{{\bf Selecting a region in an alignment.}}
837 \label{select}
838 \end{center}
839 \end{figure}
840
841 \subsection{Selecting Columns}
842 To select the same residues in all sequences, click and drag along the alignment ruler.
843 This selects the entire column of the alignment. Ranges of positions from the
844 alignment ruler can also be selected by clicking on the first position and then
845 holding down the [SHIFT] key whilst clicking the other end of the selection.
846 Discontinuous regions can be selected by holding down [CTRL] and clicking on positions to add to the column selection. Note that each [CTRL]-Click changes the current selected sequence region to that column, but adds to the column selection. Selected columns are indicated by red highlighting in the ruler bar (Figure \ref{selectcols}).
847 %[fig 13]
848
849 \begin{figure}[htbp]
850 \begin{center}
851 \includegraphics[width=4in]{images/select2.pdf}
852 \caption{{\bf Selecting multiple columns in an alignment.} The red highlighting
853 on the alignment ruler marks the selected columns. Note that only the most
854 recently selected column has a dashed-box around it to indicate a region
855 selection. }
856 \label{selectcols}
857 \end{center}
858 \end{figure}
859
860 \subsection{Selecting Sequences}
861
862 \begin{figure}[htb]
863 \begin{center}
864 \includegraphics[width=4in]{images/select3.pdf}
865 \caption{{\bf Selecting multiple sequences in an alignment.} Use [CTRL] or [SHIFT] to select many sequences at once.}
866 \label{selectrows}
867 \end{center}
868 \end{figure}
869
870 To select multiple complete sequences, click and drag the mouse down the
871 sequence ID panel. The same techniques as used for columns (above) can be used
872 with [SHIFT]-Click for continuous and [CTRL]-Click to select discontinuous
873 ranges of sequences (Figure \ref{selectrows}).
874 %[fig 14]
875
876 \subsection{Making Selections in Cursor Mode}
877
878 To define a selection in cursor mode (which is enabled by pressing [F2] when the alignment window is selected),
879 navigate to the top left corner of the proposed selection (using the mouse, the arrow keys, or the keystroke
880 commands described in Section \ref{cursormode}). Pressing the [Q] key marks this as the
881 corner. A red outline appears around the cursor (Figure \ref{cselect}).
882
883 Navigate to the bottom right corner of the proposed selection and press the [M] key. This marks the bottom right corner of the selection. The selection can then be treated in the same way as if it had been created in normal mode.
884
885 \begin{figure}[htbp]
886 \begin{center}
887 \includegraphics[width=1.5in]{images/csel1.pdf}
888 \includegraphics[width=1.5in]{images/csel2.pdf}
889 \includegraphics[width=1.5in]{images/csel3.pdf}
890 \includegraphics[width=1.5in]{images/csel4.pdf}
891 \caption{{\bf Making a selection in cursor mode.} Navigate to the top left
892 corner (left), press [Q], navigate to the bottom right corner and press [M] (right).}
893 \label{cselect}
894 \end{center}
895 \end{figure}
896
897 \begin{figure}
898 \begin{center}
899 \includegraphics[width=3in]{images/group1.pdf}
900 \includegraphics[width=1.5in]{images/newgroup.pdf}
901 \caption{{\bf Creating a new group from a selection.}}
902 \label{makegroup}
903 \end{center}
904 \end{figure}
905
906 \subsection{Inverting the Current Selection}
907 The current sequence or column selection can be inverted, using  {\sl Select
908 $\Rightarrow$ Invert Sequence/Column Selection} in the alignment window.
909 Inverting the selection is useful when selecting large regions in an alignment, 
910 simply select the region that is to be kept unselected, and then invert the selection.
911 This may also be useful when hiding large regions in an alignment (see Section \ref{hidingregions} 
912 below).
913 Instead of selecting the columns and rows that are to be hidden, simply select the 
914 region that is to be kept
915 visible, invert the selection, then select {\sl View $\Rightarrow$ Hide
916 $\Rightarrow$ Selected Region}.
917
918 \section{Creating Groups}
919 Selections are lost as soon as a different region is selected. Groups can be
920 created which are labeled regions of the alignment. To create a group, first
921 select the region which is to comprise the group. Then click the right mouse
922 button on the selection to bring up a context menu. Select {\sl Selection
923 $\Rightarrow$ Group $\Rightarrow$ Edit name and description of
924 current group}\footnote{In earlier versions of Jalview, this entry was variously
925 `Group', `Edit Group Name', or `JGroupXXXXX' (Where XXXXX was some serial
926 number).} then enter a name for the group in the dialogue box which appears.
927
928 By default the new group will have a box drawn around it. The appearance of the group can be changed (see Section \ref{colours} below). This group will stay defined even when the selection is removed.
929
930 \exercise{Making Selections and Groups}{
931 \label{exselect}
932 \exstep{Close windows.
933 Load the ferredoxin alignment (PF03460 from PFAM seed database).
934 Choose a residue and  place the mouse
935 cursor on it (Residue information will show in alignment window status
936 bar)
937 Click and drag the mouse to create a selection. As you drag, a red box
938 will `rubber band' out to 
939 show the extent of the selection.
940 Release the mouse
941 button and a red box borders the selected region.
942 Press [ESC] to clear this.}
943 \exstep{ Select one sequence by clicking on
944 the sequence ID panel. Note that the sequence ID takes on a highlighted
945 background and a red box appears around the selected sequence. 
946 Hold down [SHIFT] and click another sequence ID a few positions above or below. 
947 Note how the selection expands to include all the sequences between the two positions on which you clicked.
948 Hold down [CTRL] and then click on several sequences ID's both selected and
949 unselected. Note how unselected IDs are individually added to the selection and previously selected IDs are 
950 individually deselected.}
951 \exstep{ Select column by clicking on the Alignment Ruler. Note whole
952 column is highlighted with a red box.
953 Hold down [SHIFT] and click column beyond. Note the selection expands to include
954 all the sequences between the two positions on which you clicked.}
955
956 \exstep{ To selecting arbitrary regions in alignment, place the mouse at the top
957 left corner of the region you wish to select. Press and hold the mouse button. 
958 Drag the mouse to the bottom right corner of the chosen region and release the
959 mouse button and a dashed red box appears around the selected region}
960 \exstep{Enter Cursor mode using [F2] (or [Fn]-F2 for Macs).
961 Navigate to column 59, row 1 by pressing {\bf 5 9 , 1 [RETURN]}.
962 Press {\bf Q} to mark this position.
963 Navigate to column 65, row 8 by pressing {\bf 6 5 , 8 [RETURN]}. Press {\bf M}
964 to complete the selection. Note to clear the selection press the {\bf[ESC]}
965 key.}
966 \exstep{To create a {\bf group} from the selected the region, click the
967 right mouse button when mouse is on the selection, this opens a
968 pop-up menu in the alignment window.
969
970 Open the {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
971 } menu and select `Percentage Identity'.
972 This will turn the selected region into a group and colour it accordingly.}
973 \exstep{Hold down [CTRL] and use the mouse to select and deselect sequences in
974 the alignment by clicking on their Sequence ID label. Note how the group expands
975 to include newly selected sequences, and the `Percentage Identity' colouring changes. }
976 \exstep{ Another way to resize the group is by using the mouse to click and drag
977 the right-hand edge of the selected group.}
978
979 \exstep{The current selection can be {\bf exported} and saved by right clicking
980 on the text area to open the Sequence ID pop-up menu. Follow the menus and pick an
981 output format (eg BLC) from the {\sl Selection $\Rightarrow$ Output to Textbox
982 \ldots} submenu.
983 }
984 \exstep{In the alignment output window, try manually editing the alignment,
985 importing group into a new alignment window by clicking the [New Window] button to import the
986 file into a new alignment window.}
987 {\bf Additional help is available from videos on the Jalview website at \url{http://www.jalview.org/training/Training-Videos}.}
988 % more? change colouring style. set border colour.
989 }
990
991 \section{Exporting the Current Selection}
992 The current selection can be copied to the clipboard (in PFAM format). It can
993 also be output to a textbox using the output functions in the pop-up menu
994 obtained by right clicking the current selection. The textbox enables quick
995 manual editing of the alignment prior to importing it into a new window (using
996 the [New Window] button) or saving to a file with the {\sl File $\Rightarrow$
997 Save As } pulldown menu option from the text box.
998
999 \section{Reordering an Alignment}
1000 Sequence reordering is simple. Highlight the sequences to be moved then press the up or down arrow keys as appropriate (Figure \ref{reorder}). If you wish to move a sequence up past several other sequences it is often quicker to select the group past which you want to move it and then move the group rather than the individual sequence.
1001
1002 \begin{figure}[htbp]
1003 \begin{center}
1004 \includegraphics[width=3in]{images/move1.pdf}
1005 \includegraphics[width=3in]{images/move2.pdf}
1006 \caption{{\bf Reordering the alignment.} The selected sequence moves up one
1007 position on pressing the $\uparrow$ key.}
1008 \label{reorder}
1009 \end{center}
1010 \end{figure}
1011
1012 \exercise{Reordering the Alignment}{
1013 \exstep{Close all windows in Jalview from desktop. Load the ferredoxin alignment (e.g.the
1014 PFAM domain PF03460 from PFAM seed).
1015 Select one of the sequence in the sequence ID panel, use the up and down
1016 arrow keys to alter the sequence's position in the alignment. (Note that
1017 this will not work in cursor mode)}
1018 \exstep{To select and move multiple
1019 sequences, use hold [SHIFT] and [CTRL], and select two sequences separated by
1020 one or more un-selected sequences. Note how multiple sequences are grouped
1021 together when they are re-ordered using the up and down arrow keys.}
1022 {\bf Additional help is available from videos on the Jalview website
1023 at \url{http://www.jalview.org/training/Training-Videos}.}}
1024
1025
1026 \section{Hiding Regions}
1027 \label{hidingregions}
1028 It is sometimes convenient to exclude some sequences or residues in the alignment without actually deleting them. Jalview allows sequences or alignment columns within a view to be hidden, and this facility has been used to create the several different views in the example alignment file that is loaded when Jalview is first started (See Figure \ref{startpage}).
1029
1030 To hide a set of sequences, select them and right-click the mouse on the
1031 selected sequence IDs to bring up the context pop-up menu. Select {\sl Hide
1032 Sequences} and the sequences will be concealed, with a small blue triangle indicating their position (Figure \ref{hideseq}). To unhide (reveal) the sequences, right click on the triangle and select {\sl Reveal Sequences} from the context menu.
1033
1034
1035  \begin{figure}[htbp]
1036 \begin{center}
1037 \includegraphics[width=1.5in]{images/hide1.pdf}
1038 \includegraphics[width=2.5in]{images/hide2.pdf}
1039 \includegraphics[width=1.75in]{images/hide3.pdf}
1040 \caption{{\bf Hiding Sequences} Hidden sequences are represented by a small blue
1041 triangle in the sequence ID panel.}
1042 \label{hideseq}
1043 \end{center}
1044 \end{figure}
1045
1046 A similar mechanism applies to columns (Figure \ref{hidecol}). Selected columns
1047 (indicated by a red marker) can be hidden and revealed in the same way {\sl via}
1048 the context pop-up menu by right clicking on the ruler bar. The hidden column
1049 selection is indicated by a small blue triangle in the ruler bar.
1050
1051  \begin{figure}[htbp]
1052 \begin{center}
1053 \includegraphics[width=2in]{images/hide4.pdf}
1054 \includegraphics[width=3in]{images/hide5.pdf}
1055 \includegraphics[width=1in]{images/hide6.pdf}
1056 \caption{{\bf Hiding Columns} Hidden columns are represented by a small blue
1057 triangle in the ruler bar.}
1058 \label{hidecol}
1059 \end{center}
1060 \end{figure}
1061
1062 It is often easier to select the region that you intend to work with, rather
1063 than the regions that you want to hide. In this case, select the required region and use the {\sl View $\Rightarrow$ Hide
1064 $\Rightarrow$ All but Selected Region } menu entry, or press [Shift]+[Ctrl]+H
1065 to hide the unselected region.
1066
1067 \subsection{Representing a Group with a Single Sequence}
1068
1069 Instead of hiding a group completely, it is sometimes useful to work with just one representative sequence. The {\sl $<$Sequence ID$>$ $\Rightarrow$ Represent group with $<$Sequence ID$>$ } option from the sequence ID pop-up menu enables this variant of the hidden groups function. The remaining representative sequence can be visualized and manipulated like any other. However, any alignment edits that affect the sequence will also affect the whole sequence group. 
1070
1071 \exercise{Hiding and Revealing Regions}{
1072 \exstep{Close all windows, open the PFAM accession PF03460. Select a
1073 contiguous set of sequences by clicking and dragging on the sequence ID panel.
1074 Right click on the selected sequence IDs to bring up the sequence ID pop-up
1075 menu, select {\sl Hide Sequences}.
1076 }
1077 \exstep{
1078 Right click on the blue triangle indicating hidden sequences and select {\sl
1079 Reveal Sequences} in the panel. (If you have hidden all sequences then you will
1080 need to use the alignment window menu option {\sl View $\Rightarrow$ Show $\Rightarrow$ 
1081 All Sequences.}) }
1082 \exstep{
1083 Repeat the process but use a non-contiguous set of sequences. Note that when
1084 multiple regions are hidden there are two options, {\sl Reveal Sequences} and {\sl Reveal All}.
1085 }
1086 \exstep{Repeat the above using columns to hide and reveal columns
1087 instead of sequences.}
1088 \exstep{Select a region of the alignment, then add in some additional columns to
1089 the selection, and experiment with the `Hide all but selected region' function
1090 in {\sl View $\Rightarrow$ Hide $\Rightarrow$ All but selected region.}}
1091 \exstep{Select some sequences and pick one to represent the rest by hovering
1092 the mouse over this sequence. Bring up the Sequence ID pop-up menu by right
1093 clicking and then select {\sl (Sequence ID name) $\Rightarrow$ Represent group
1094 with (Sequence ID name )}. To reveal these hidden sequences, right click on the
1095 Sequence ID and in the pop-up menu select Reveal All.}
1096 {\bf Additional help is available from videos on the Jalview
1097 website at \url{http://www.jalview.org/training/Training-Videos}}}
1098
1099
1100 \begin{figure}[htb]
1101 \begin{center}
1102 \includegraphics[width=3in]{images/edit1.pdf}
1103 \includegraphics[width=3in]{images/edit2.pdf}
1104 \caption{{\bf Introducing gaps in a single sequence.} Gaps are introduced as the
1105 selected sequence is dragged to the right while pressing and holding [SHIFT].}
1106 \label{gapseq}
1107 \end{center}
1108 \end{figure}
1109
1110 \begin{figure}[htb]
1111 \begin{center}
1112 \includegraphics[width=3in]{images/edit3.pdf}
1113 \includegraphics[width=3in]{images/edit4.pdf}
1114 \caption{{\bf Introducing gaps in a group.} Gaps are introduced as the selected
1115 group is dragged to the right with [CTRL] pressed.}
1116 \label{gapgroup}
1117 \end{center}
1118 \end{figure}
1119
1120 \section{Introducing and Removing Gaps}
1121 The alignment view provides an interactive editing interface, allowing gaps to be inserted or deleted to the left of any position in a sequence or sequence group. Alignment editing can only be performed whilst in keyboard editing mode (entered by pressing [F2]) or by clicking and dragging residues with the mouse when [SHIFT] or [CTRL] is held down (which differs from earlier versions of Jalview).
1122
1123 \subsection{Locked Editing}
1124 \label{lockededits}
1125 The Jalview alignment editing model is different to that used in other alignment
1126 editors. Because edits are restricted to the insertion and deletion of gaps to the left of a particular sequence position, 
1127 editing has the effect of shifting the rest of the sequence(s) being edited down or up-stream with respect to the rest of 
1128 alignment. The {\sl Edit $\Rightarrow$ Pad Gaps} option can be enabled to eliminate `ragged edges' at the end of the alignment, 
1129 but does not avoid the `knock-on' effect which is sometimes undesirable. 
1130 However, its effect can be limited by performing the edit within a selected region. 
1131 In this case, gaps will only be removed or inserted within the selected region. 
1132 Edits are similarly constrained when they occur adjacent to a hidden column.
1133
1134 \subsection{Introducing Gaps in a Single Sequence}
1135 To introduce a gap, first select the sequence in the sequence ID panel and
1136 then place the cursor on the residue to the immediate right of where the gap
1137 should appear. Hold down the SHIFT key and the left mouse button, then drag the sequence to the right until the required number of gaps has been inserted.
1138
1139 One common error is to forget to hold down [SHIFT]. This results in a selection which is one sequence high and one residue long. Gaps cannot be inserted in such a selection. The selection can be cleared and editing enabled by pressing the [ESC] key.
1140
1141 \subsection{Introducing Gaps in all Sequences of a Group}
1142 To insert gaps in all sequences in a selection or group, select the
1143 required sequences in the sequence ID panel and then place the mouse cursor on
1144 any residue in the selection or group to the immediate right of the position in which a gap should appear. Hold down the CTRL key and the left mouse button, then drag the sequences to the right until the required number of gaps has appeared.
1145
1146 Gaps can be removed by dragging the residue to the immediate right of the gap
1147 leftwards whilst holding down [SHIFT] (for single sequences) or [CTRL] (for a group of sequences).
1148
1149 \subsection{Sliding Sequences}
1150 Pressing the [$\leftarrow$] or [$\rightarrow$] arrow keys when one or more
1151 sequences are selected will ``slide'' the entire selected sequences to the left
1152 or right (respectively). Slides occur regardless of the region selection -
1153 which, for example, allows you to easily reposition misaligned subfamilies
1154 within a larger alignment.
1155 % % better idea to introduce hiding sequences, and use the invert selection, hide
1156 % others, to simplify manual alignment construction
1157
1158 \exercise{Editing Alignments}
1159   %\label{mousealedit}
1160 % TODO: VERIFY FOR 2.6.1 and 2.7 - NUMBERING/INSTRUCTIONS APPEAR OFF
1161 {You are going to manually reconstruct part of the example Jalview
1162 alignment available at
1163  \href{http://www.jalview.org/examples/exampleFile.jar}
1164  {http://www.jalview.org/examples/exampleFile.jar}.
1165 Remember to use [CTRL]+Z to undo an edit, or the {\sl File $\Rightarrow$
1166  Reload } function to revert the alignment back to the original version if you
1167  want to start again.
1168 If you are using OSX, and a key combination - such as [CTRL]+A - does
1169  not work, then try pressing the [CMD] key instead of [CTRL].
1170
1171 \exstep{ Load the URL
1172 \textsf{http://www.jalview.org/tutorial/unaligned.fa} which contains part of the
1173 ferredoxin alignment from PF03460.}
1174
1175 \exstep{ Select the first 7 sequences, and press H to hide them (or right click
1176 on the sequence IDs to open the sequence ID pop-up menu, and select {\sl Hide
1177 Sequences}).}
1178
1179 \exstep{ Select FER3\_RAPSA and FER\_BRANA. Slide the sequences to
1180 the right so the initial {\bf A} lies at column 57 using the $\Rightarrow$ key.}
1181
1182 \exstep{ Select FER1\_SPIOL, FER1\_ARATH, FER2\_ARATH, Q93Z60\_ARATH and
1183 O80429\_MAIZE
1184 (Hint: you can do this by pressing [CTRL]-I to invert the sequence selection and then
1185 deselect FER1\_MAIZE), and use the $\Rightarrow$ key to slide them to so they
1186 begin at column 5 of the alignment view.} 
1187
1188 \exstep{ Select all the visible
1189 sequences (those not hidden) in the block by pressing [CTRL]-A.
1190 Insert a single
1191 gap in all selected sequences at column 38 of the alignment by holding [CTRL]
1192 and clicking on the R at column 38 in the FER1\_SPIOL, then drag one
1193 column to right.
1194 Insert another gap at column 47 in all sequences in the same way.}
1195
1196 \exstep{ Correct the ferredoxin domain alignment for FER1\_SPIOL by
1197 inserting two additional gaps after the gap at column 47: First press [ESC] to
1198 clear the selection, then hold [SHIFT] and click and drag on the G and move it
1199 two columns to the right.}
1200
1201 \exstep{ Now complete the
1202 alignment of FER1\_SPIOL with a {\bf locked edit} by pressing [ESC] and select
1203 columns 47 to 57 of the FER1\_SPIOL row. Move the mouse onto the G at column 50,
1204 hold [SHIFT] and drag the G in column 47 of FER1\_SPIOL to the left by one
1205 column to insert a gap at column 57.}
1206
1207 \exstep{ In the next two steps you will complete the alignment of the last two 
1208 sequences.
1209
1210 Select the last two sequences (FER1\_MAIZE and O80429\_MAIZE), then press [SHIFT]
1211 and click and drag the initial methionine of O80429\_MAIZE 5 columns to the right
1212 so it lies at column 10.
1213
1214 Keep holding [SHIFT] and click and drag to insert
1215 another gap at the proline at column 25 (25C in cursor mode). Remove the gap at
1216 column 44, and insert 4 gaps at column 47 (after AAPM).}
1217
1218 \exstep{ Hold [SHIFT] and drag the I at column 39 of FER1\_MAIZE 2 columns to the
1219 right. Remove the gap at FER1\_MAIZE column 49 by [SHIFT]+click and drag left by
1220 one column. Press [ESC] to clear the selection, and then insert three gaps in
1221 FER1\_MAIZE at column 47 by holding [SHIFT] and click and drag the S in FER1\_MAIZE to the right by three columns. Finally,
1222 remove the gap in O80429\_MAIZE at column 56 using [SHIFT]-drag to the left on
1223 56C.}
1224
1225 \exstep{ Use the
1226 {\sl Edit $\Rightarrow$ Undo Edit} and {\sl Edit $\Rightarrow$ Redo Edit} menu
1227 option, or their keyboard shortcuts ([CTRL]+Z and [CTRL]+Y) to step 
1228 backwards and replay the edits you have made.}
1229 }
1230
1231 \subsection{Editing in Cursor mode}
1232 Gaps can be easily inserted when in cursor mode (toggled with [F2]) by
1233 pressing [SPACE]. Gaps will be inserted at the cursor, shifting the residue
1234 under the cursor to the right. To insert {\sl n} gaps type {\sl n} and then
1235 press [SPACE]. To insert gaps into all sequences of a group, use [CTRL]-[SPACE]
1236 or [SHIFT]-[SPACE] (both keys held down together).
1237
1238 Gaps can be removed in cursor mode by pressing [BACKSPACE]. First make sure you
1239 have everything unselected by pressing ESC. The gap under the cursor will be
1240 removed. To remove {\sl n} gaps, type {\sl n} and then press [BACKSPACE]. Gaps
1241 will be deleted up to the number specified. To delete gaps from all sequences of
1242 a group, press [CTRL]-[BACKSPACE] or [SHIFT]-[BACKSPACE] (both keys held down
1243 together). Note that the deletion will only occur if the gaps are in the same
1244 columns in all sequences in the selected group, and those columns are to the
1245 right of the selected residue.
1246
1247 \section{Undoing Edits}
1248 Jalview supports the undoing of edits {\sl via} the {\sl Edit $\Rightarrow$ Undo Edit}
1249 alignment window menu option, or CTRL-Z. An edit, if undone, may be re-applied
1250 with {\sl Edit $\Rightarrow$ Redo Edit}, or CTRL-Y. Note, however, that the
1251 {\sl Undo} function only works for edits to the alignment or sequence ordering.
1252 Colouring of the alignment, showing and hiding of sequences or modification of
1253 annotation cannot be undone.
1254
1255 \exercise{Keyboard Edits}
1256 {This continues on from exercise
1257 \ref{mousealedit}, and recreates the final part of the example ferredoxin
1258 alignment from the unaligned sequences using Jalview's keyboard editing mode.
1259
1260 {\bf Note:} For Mac users, [CTRL]-[SPACE] command
1261 has the same effect as the [SHIFT]-[SPACE] command mentioned in this exercise.
1262 Window users should use [SHIFT]-[SPACE] rather than the [CTRL]-[SPACE] command,
1263 as this command will close the window.
1264
1265 \exstep{Load the sequence alignment at
1266 \textsf{http://www.jalview.org/tutorial/unaligned.fa}, or continue using the
1267 edited alignment from exercise \ref{mousealedit}.  If you continue from the
1268 previous exercise, first right click on the sequence ID panel and select
1269 {\sl Reveal All}. Enter cursor mode by pressing [F2].}
1270 % TODO: BACKSPACE or DELETE WHEN SEQS ARE SELECTED WILL DELETE ALL SEQS JAL-783
1271
1272 \exstep{Insert 58 gaps at the start of the sequence 1 (FER\_CAPAA). Press
1273 {\sl 58} then {\sl [SPACE]}. }
1274
1275 \exstep{Go down one sequence and select rows 2-5 as a block. Click on the second sequence ID (FER\_CAPAN).
1276  Hold down shift and click on the fifth (FER1\_PEA). }
1277
1278 \exstep{Insert 6 gaps at the start of this group. Go to column 1 row 2 by typing
1279 {\sl 1,2} then press {\sl [RETURN]}. Now insert 6 gaps in all the sequences.
1280 Type {\sl 6} then hold down {\sl [SHIFT]} and press {\sl [SPACE]}.}
1281 \exstep{Now insert one gap at column 34 and another at 38. Insert 3 gaps at 47.
1282 Press {\sl 34C} then {\sl [SHIFT]-[SPACE]}.  Press {\sl 38C} then
1283 [SHIFT]-[SPACE].
1284 Press {\sl 47C} then {\sl 3 [SHIFT-SPACE]} the first through fourth sequences
1285 are now aligned.}
1286 \exstep{The fifth sequence (FER1\_PEA) is poorly aligned. We will delete some gaps and add some new ones. Press {\sl [ESC]} to clear the selection. Navigate to the start of sequence 5 and delete 3 gaps. Press {\sl 1,5 [RETURN]} then {\sl 3 [BACKSPACE]} to delete three gaps. Go to column 31 and delete the gap. Press {\sl 31C [BACKSPACE]} .}
1287 \exstep{ Similarly delete the gap now at column 34, then insert two gaps at
1288 column 38.
1289 Press {\sl 34C [BACKSPACE]  38C 2 [SPACE]}. Delete three gaps at column 44 and
1290 insert one at column 47 by pressing {\sl 44C 3 [BACKSPACE] 47C [SPACE]}.  The top five sequences are 
1291 now aligned.}
1292 }
1293
1294 \chapter{Colouring Sequences and Figure Generation}
1295 \label{colouringfigures}
1296 \section{Colouring Sequences}
1297 \label{colours}
1298
1299 Colouring sequences is a key aspect of alignment presentation. Jalview allows
1300 you to colour the whole alignment, or just specific groups. Alignment and
1301 group colours are rendered
1302 {\sl below} any other colours, such as those arising from sequence features
1303 (these are described in Section \ref{featannot}). This means that if you
1304 try to apply one of the colourschemes described in this section, and nothing
1305 appears to happen, it may be that you have sequence feature annotation
1306 displayed, and you may have to disable it using the {\sl View $\Rightarrow$
1307 Show Features} option before you can see your colourscheme.
1308
1309 There are two main types of colouring styles: {\bf simple static residue}
1310 colourschemes and {\bf dynamic schemes} which use conservation and consensus
1311 analysis to control colouring. {\bf Hybrid colouring} is also possible, where
1312 static residue schemes are modified using a dynamic scheme. The individual schemes are described in Section \ref{colscheme} below.
1313
1314 \subsection{Colouring the Whole Alignment}
1315
1316 \parbox[c]{3.75in}{The alignment can be coloured {\sl via} the {\sl Colour} menu option in the alignment window. Selecting the colour scheme causes all residues to be coloured. The menu is divided into three sections. The first section gives options for the behaviour of the menu options, the second lists static and dynamic colourschemes available for selection. The last gives options for making hybrid colourschemes using conservation shading or colourscheme thresholding. 
1317
1318 }\parbox[c]{3in}{
1319 \centerline {
1320 \includegraphics[width=2.5in]{images/colour2.pdf}
1321 }
1322 }
1323
1324 \subsection{Colouring a Group or Selection}
1325
1326 Selections or groups can be coloured in two ways. The first is {\sl via} the Alignment Window's {\sl Colour} menu as stated above,
1327  after first ensuring that the {\sl Apply Colour To All Groups} flag is not selected. 
1328  This must be turned {\sl off} specifically as it is {\sl on} by default. 
1329  When unticked, selections from the Colours menu will only change the colour for residues in the current selection, 
1330  or the alignment view's ``background colourscheme'' when no selection exists.
1331
1332 The second method is to select sequences and right click mouse to open pop-up
1333 menu and select {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group
1334 Colour} from context menu options
1335 (Figure \ref{colgrp}). This only changes the colour of the current selection or group.
1336
1337 \begin{figure}[htbp]
1338 \begin{center}
1339 %TODO update group_col.pdf to show latest jalview group edit submenu
1340 \includegraphics[width=4in]{images/group_col.pdf}
1341 \caption{{\bf Colouring a group via the context menu.}}
1342 \label{colgrp}
1343 \end{center}
1344 \end{figure}
1345
1346 \subsection{Shading by Conservation}
1347 For many colour schemes, the intensity of the colour in a column can be scaled
1348 by the degree of amino acid property conservation. Selecting {\sl Colour
1349 $\Rightarrow$ By Conservation} enables this mode, and {\sl Modify
1350 Conservation Threshold...} brings up a selection box (the {\sl Conservation
1351 Colour Increment} dialog box) allowing the alignment colouring to be modified.
1352 Selecting a higher value limits colouring to more highly conserved columns (Figure \ref{colcons}).
1353
1354  \begin{figure}[htbp]
1355 \begin{center}
1356 \includegraphics[width=2in]{images/colourcons1.pdf}
1357 \includegraphics[width=2in]{images/colourcons3.pdf}
1358 \includegraphics[width=2in]{images/colourcons5.pdf}
1359 \caption{{\bf Conservation Shading} The density of the ClustalX style residue colouring is controlled by the conservation threshold. The effect of 0\% (left), 50\% (center) and 100\% (right) thresholds are shown.
1360 }
1361 \label{colcons}
1362 \end{center}
1363 \end{figure}
1364
1365 \subsection{Thresholding by Percentage Identity}
1366
1367 `Thresholding' is another hybrid colour model where a residue is only coloured
1368 if it is not excluded by an applied threshold. Selecting {\sl Colour $\Rightarrow$ Above Identity Threshold} brings up a selection box with a slider controlling the minimum percentage identity threshold to be applied. Selecting a higher threshold (by sliding to the right) limits the colouring to columns with a higher percentage identity (as shown by the Consensus histogram in the annotation panel).
1369
1370 \subsection{Colouring by Annotation}
1371 \label{colourbyannotation}
1372 \parbox[c]{3.2in}{
1373 Any of the {\bf quantitative} annotations shown on an alignment can be used to
1374 threshold or shade the whole alignment.\footnote{Please remember to turn off
1375 Sequence Feature display to see the shading} 
1376
1377 The {\sl Colour $\Rightarrow$ By
1378 Annotation} option opens a dialog which allows you to select which annotation
1379 to use, the minimum and maximum shading colours or whether the original
1380 colouring should be thresholded (the `Use original colours' option).
1381
1382 Default settings for minimum and maximum colours can be set in the Jalview
1383 Desktop's preferences.  
1384 }\parbox[c]{3in}{
1385 \centerline{\includegraphics[width=2.8in]{images/col_byannot.pdf}}}
1386
1387 The {\bf per Sequence} option in the {\bf Colour By Annotation} dialog
1388 allows each sequence to be shaded according to sequence associated annotation
1389 rows, such as protein disorder scores. This functionality is described further
1390 in Section \ref{protdisorderpred}.
1391
1392 \subsection{Colour Schemes} 
1393
1394 \label{colscheme}
1395 Full details on each colour scheme can be found in the Jalview on-line help. A brief description of each one is provided below:
1396
1397 \subsubsection{ClustalX}
1398
1399
1400  \parbox[c]{3.5in}{This is an emulation of the default colourscheme used for alignments in ClustalX, a graphical interface for the ClustalW multiple sequence alignment program. Each residue in the alignment is assigned a colour if the amino acid profile of the alignment at that position meets some minimum criteria specific for the residue type. }
1401 \parbox[c]{3in}{\includegraphics[width=2.75in]{images/col_clustalx.pdf}}
1402
1403 \subsubsection{Blosum62}
1404
1405 \parbox[c]{3.5in}{Gaps are coloured white. If a residue matches the consensus sequence residue at that position it is coloured dark blue. If it does not match the consensus residue but the Blosum62 matrix gives a positive score, it is coloured light blue.}
1406 \parbox[c]{3in}{
1407 \includegraphics[width=2.75in]{images/col_blosum62.pdf}
1408 }
1409
1410 \subsubsection{Percentage Identity}
1411 \parbox[c]{3.5in}{
1412 The Percent Identity option colours the residues (boxes and/or text) according to the percentage of the residues in each column that agree with the consensus sequence. Only the residues that agree with the consensus residue for each column are coloured.
1413 }
1414 \parbox[c]{3in}{
1415 \includegraphics[width=2.75in]{images/col_percent.pdf}
1416 }
1417
1418 \subsubsection{Zappo}
1419 \parbox[c]{3.5in}{
1420 The residues are coloured according to their physicochemical properties. The physicochemical groupings are Aliphatic/hydrophobic, Aromatic, Positive, Negative, Hydrophillic, conformationally special, and Cyst(e)ine.
1421 }
1422 \parbox[c]{3in}{
1423 \includegraphics[width=2.75in]{images/col_zappo.pdf}
1424 }
1425
1426 \subsubsection{Taylor}
1427
1428 \parbox[c]{3.5in}{
1429 This colour scheme was devised by Willie Taylor and an entertaining description of its origin can be found in Protein Engineering, 
1430 Vol 10 , 743-746 (1997).
1431 }
1432 \parbox[c]{3in}{
1433 \includegraphics[width=2.75in]{images/col_taylor.pdf}
1434 }
1435
1436 \subsubsection{Hydrophobicity}
1437 \parbox[c]{3.5in}{
1438 Residues are coloured according to the hydrophobicity table of Kyte, J., and Doolittle, R.F., J. Mol. Biol. 1157, 105-132, 1982. The most hydrophobic residues are coloured red and the most hydrophilic ones are coloured blue.
1439 }
1440 \parbox[c]{3in}{
1441 \includegraphics[width=2.75in]{images/col_hydro.pdf}
1442 }
1443
1444 \subsubsection{Helix Propensity}
1445
1446 \parbox[c]{3.5in}{
1447 The residues are coloured according to their Chou-Fasman\footnote{\label{chou-fasman}Chou, PY and Fasman, GD. Annu Rev Biochem. 1978;47:251-76.} helix propensity. The highest propensity is magenta, the lowest is green.
1448 }
1449 \parbox[c]{3in}{
1450 \includegraphics[width=2.75in]{images/col_helix.pdf}
1451 }
1452
1453 \subsubsection{Strand Propensity}
1454
1455 \parbox[c]{3.5in}{
1456 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} Strand propensity. The highest propensity is Yellow, the lowest is blue.
1457 }
1458 \parbox[c]{3in}{
1459 \includegraphics[width=2.75in]{images/col_strand.pdf}
1460 }
1461
1462
1463
1464 \subsubsection{Turn Propensity}
1465 \parbox[c]{3.5in}{
1466 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} turn propensity. The highest propensity is red, the lowest is cyan.
1467 }
1468 \parbox[c]{3in}{
1469 \includegraphics[width=2.75in]{images/col_turn.pdf}
1470 }
1471
1472 \subsubsection{Buried Index}
1473 \parbox[c]{3.5in}{
1474 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} burial propensity. The highest propensity is blue, the lowest is green.
1475 }
1476 \parbox[c]{3in}{
1477 \includegraphics[width=2.75in]{images/col_buried.pdf}
1478 }
1479  
1480
1481 \subsubsection{Nucleotide}
1482 \parbox[c]{3.5in}{ Residues are coloured with four colours corresponding to the
1483 four nucleotide bases. All non ACTG residues are uncoloured. See Section
1484 \ref{workingwithnuc} for further information about working with nucleic acid
1485 sequences and alignments.
1486 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_nuc.pdf} }
1487
1488 \subsubsection{Purine Pyrimidine}
1489 \parbox[c]{3.5in}{ Residues are coloured according to whether the corresponding
1490 nucleotide bases are purine (magenta) or pyrimidine (cyan) based. All non ACTG
1491 residues are uncoloured. For further information about working with nucleic acid
1492 sequences and alignments, see Section \ref{workingwithnuc}.
1493 %and Section \ref{workingwithrna}
1494
1495 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_purpyr.pdf} }
1496
1497 \subsubsection{RNA Helix Colouring}
1498 \parbox[c]{3.5in}{ Columns are coloured according to their assigned RNA helix as
1499 defined by a secondary structure annotation line on the alignment. Colours for
1500 each helix are randomly assigned, and option only available when an RNA
1501 secondary structure row is present on the alignment. 
1502 % For more details see Section \ref{workingwithrna} 
1503 } \parbox[c]{3in}{
1504 \includegraphics[width=2.75in]{images/col_rnahelix.pdf} }
1505
1506 \exercise{Colouring Alignments}{ 
1507 \exstep{Ensuring that the {\sl Apply Colour To All Groups} flag is not selected
1508 in View sequence alignment menu.
1509  This must be turned {\sl off} specifically as it is {\sl on} by default.}
1510 \exstep{
1511 Open a sequence alignment, for example the PFAM domain PF03460 in PFAM seed.
1512 Select the alignment menu option {\sl Colour $\Rightarrow$ ClustalX}. Note the colour change. Now try all the other colour schemes in the {\sl Colour} menu. Note that some colour schemes do not colour all residues.
1513 }
1514 \exstep{
1515 Colour the alignment using {\sl Colour  $\Rightarrow$ Blosum62}. Select a group
1516 of around 4 similar sequences. Use the context menu (right click on the group)
1517 option {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
1518 $\Rightarrow$ Blosum62} to colour the selection. Notice how some residues which
1519 were not coloured are now coloured. The calculations performed for dynamic
1520 colouring schemes like Blosum62 are based on the group being coloured, not the
1521 whole alignment (this also explains the colouring changes observed in exercise
1522 \ref{exselect} during the group selection step).
1523 }
1524 \exstep{
1525 Keeping the same selection as before, colour the complete alignment except
1526 the group using {\sl Colour  $\Rightarrow$ Taylor}.
1527 Select the menu option  {\sl Colour  $\Rightarrow$ By Conservation}. 
1528 Slide the selector from side to side and observe the changes in the alignment colouring in the selection and in the complete alignment. 
1529 }
1530 }
1531
1532 \subsubsection{User Defined}
1533 This dialogue allows the user to create any number of named colour schemes at will. Any residue may be assigned any colour. The colour scheme can then be named. If you save the colour scheme, this name will appear on the Colour menu (Figure \ref{usercol}).
1534
1535
1536 \begin{figure}[htbp]
1537 \begin{center}
1538 \includegraphics[width=2.5in]{images/col_user1.pdf}
1539 \includegraphics[width=2in]{images/col_user2.pdf}
1540 \includegraphics[width=1.75in]{images/col_user3.pdf}
1541 \caption{{\bf Creation of a user defined colour scheme.} Residue types are assigned colours (left). The profile is saved (center) and can then be accessed {\sl via} the {\sl Colour} menu (right).}
1542 \label{usercol}
1543 \end{center}
1544 \end{figure}
1545
1546
1547 \exercise{User Defined Colour Schemes}{
1548 \exstep{Load a sequence alignment. Select the alignment menu option {\sl Colour $\Rightarrow$ User Defined}. A dialogue window will open.
1549 }
1550 \exstep{Click on an amino acid button, then select a colour for that amino acid. Repeat till all amino acids are coloured to your liking.
1551 }
1552 \exstep{ Insert a name for the colourscheme in the appropriate field and click {\sl Save Scheme}. You will be prompted for a file name in which to save the colour scheme. The dialogue window can now be closed.
1553 }
1554 \exstep{
1555 The new colour scheme appears in the list of colour schemes in the {\sl Colour} menu and can be selected in future Jalview sessions.
1556 }
1557 }
1558
1559 \section{Formatting and Graphics Output}
1560 \label{layoutandoutput}
1561 Jalview is a WYSIWIG alignment editor. This means that for most kinds of graphics output, 
1562 the layout that is seen on screen will be the same as what is outputted in an
1563 exported graphics file.
1564 It is therefore important to pick the right kind of display layout prior to generating figures. 
1565
1566 \subsection{Multiple Alignment Views}
1567
1568 Jalview is able to create multiple independent visualizations of the same underlying alignment - these are called {\sl Views}. Because each view displays the same underlying data, any edits performed in one view will update the alignment or annotation visible in all views.
1569
1570 \parbox[c]{4in}{Alignment views are created using the {\sl View $\Rightarrow$ New View} option of the alignment window or by Pressing [CTRL]-T. This will create a new view with the same groups, alignment layout and display options as the current one. Pressing G will gather together Views as named tabs on the alignment window, and pressing X will expand gathered Views so they can be viewed simultaneously in their own separate windows. To delete a group, press [CTRL]-W.}\parbox[c]{2.75in}{
1571 \begin{center}\centerline{
1572 \includegraphics[width=2.5in]{images/mulv_tabs.pdf}}
1573 \end{center}
1574 }
1575
1576 % JBPNote make an excercise on views ?
1577
1578 \subsection{Alignment Layout}
1579 Jalview provides two screen layout modes, unwrapped (the default) where the alignment is in one long line across the window, and wrapped, where the alignment is on multiple lines, each the width of the window. Most layout options are controlled by the Format menu option in the alignment window, and control the overall look of the alignment in the view (rather than just a selected region).
1580
1581 \subsubsection{Wrapped Alignments}
1582 Wrapped alignments can be toggled on and off using the {\sl Format $\Rightarrow$ Wrap} menu option (Figure \ref{wrap}). Note that the annotation lines are also wrapped. Wrapped alignments are great for publications and presentations but are of limited use when working with large numbers of sequences. 
1583
1584 If annotations are not all visible in wrapped mode, expand the alignment window to view them. Note that alignment annotation (see Section \ref{featannot}) cannot be interactively created or edited in wrapped mode, and selection of large regions is difficult. 
1585 \begin{figure}[htbp]
1586 \begin{center}
1587 \parbox[c]{2in}{\includegraphics[width=2in]{images/wrap1.pdf}}
1588 \parbox[c]{4in}{\includegraphics[width=4in]{images/wrap2.pdf}}
1589 \caption{{\bf Wrapping the alignment.}}
1590 \label{wrap}
1591 \end{center}
1592 \end{figure}
1593
1594
1595 \subsubsection{Fonts}
1596
1597 \parbox[c]{4in}{The text appearance in a view can be modified {\sl via} the {\sl Format $\Rightarrow$ Font\ldots} alignment window menu. This setting applies for all alignment and annotation text except for that displayed in tool-tips. Additionally, font size and spacing can be adjusted rapidly by clicking the middle mouse button and dragging across the alignment window.}
1598 \parbox[c]{2in}{\centerline{\includegraphics[width=1.75in]{images/font.pdf}}}
1599
1600 \subsubsection{Numbering and Label Justification}
1601 Options in the {\sl Format} menu are provided to control the alignment view, and provide a range of options to control the display of sequence and alignment numbering, the justification of sequence IDs and annotation row column labels on the annotation rows shown below the alignment.
1602
1603 \subsubsection{Alignment and Group Colouring and Appearance}
1604 The display of hidden row/column markers and gap characters can be turned off with {\sl Format $\Rightarrow$ Hidden Markers} and {\sl Format $\Rightarrow$ Show Gaps}, respectively. The {\sl Text} and {\sl Colour Text} option controls the display of sequence text and the application of alignment and group colouring to it. {\sl Boxes } controls the display of the background area behind each residue that is coloured by the applied coloursheme.  
1605
1606 \subsubsection{Highlighting Nonconserved Symbols}
1607 The alignment layout and group sub-menu both contain an option to hide
1608 conserved symbols from the alignment display ({\sl Format $\Rightarrow$ Show
1609 nonconserved } in the alignment window or {\sl Selection $\Rightarrow$ Group
1610 $\Rightarrow$ Show Nonconserved} by right clicking on a group). This mode is useful when working with
1611 alignments that exhibit a high degree of homology, because Jalview will only
1612 display gaps or sequence symbols that differ from the consensus for each
1613 column, and render all others with a `.'.
1614 %TODO add a graphic to illustrate this.
1615 \subsection{Annotation Ordering and Display}
1616 % TODO: describe consensus, conservation, quality user preferences, and group
1617 % annotation preferences.
1618 The annotation lines which appear below the sequence alignment are described in
1619 detail in Section \ref{featannot}. They can be hidden by toggling the {\sl View
1620 $\Rightarrow$ Show Annotations} menu option. Additionally, each annotation line
1621 can be hidden and revealed in the same way as sequences {\sl via} the
1622 pop-up context menu on the annotation name panel (Figure \ref{annot}).
1623 Annotations can be reordered by dragging the annotation line label on the annotation label panel. Placing the
1624 mouse over the top annotation label brings up a resize icon on the left. When this is
1625 displayed, Click-dragging up and down provides more space in the alignment window for viewing the annotations, and less space for the sequence alignment.
1626
1627 \begin{figure}
1628 \begin{center}
1629 \includegraphics[width=2.5in]{images/annot1.pdf}
1630 \includegraphics[width=2.5in]{images/annot2.pdf}
1631 \caption{{\bf Hiding Annotations} Annotations can either be hidden from the {\sl
1632 View} menu (left) or individually from the context menu (right).}
1633 \label{annot}
1634 \end{center}
1635 \end{figure}
1636
1637 \exercise{Alignment Layout}{
1638 \label{exscreen}
1639 \exstep{Start Jalview and open the URL \textsf{http://www.jalview.org/examples/exampleFile.jar}. 
1640 Select {\sl Format $\Rightarrow$ Wrap} from the alignment window menu. 
1641 Experiment with the various options from the {\sl Format} menu, for example adjust the ruler placement, 
1642 sequence ID format and so on. }
1643 \exstep{Hide all the annotation rows by selecting {\sl Annotations $\Rightarrow$
1644 Show Annotations} from the alignment window menu. Reveal the annotations by selecting the same menu option.} \exstep{Deselect {\sl Format $\Rightarrow$ Wrap}. Right click on the
1645 annotation row labels to bring up the pop-up context menu, then select {\sl
1646 Hide This Row}. Bring up the pop-up context menu again and select {\sl
1647 Show All Hidden Rows} to reveal them.}
1648 \exstep{Annotations can be reordered by clicking and dragging the row to the desired position. Click on the {\sl Consensus} row and drag it upwards to just above {\sl Quality}. The rows should now be reordered. Features and annotations are covered in more detail in Section \ref{featannot} below.}
1649 \exstep{Move the mouse to the top left hand corner of the Secondary Structure annotation row label - 
1650 a grey up/down arrow symbol should appear - when this is shown, the height of the {\sl Annotation Area} can be changed 
1651 by clicking and dragging the mouse up or down.}
1652 }
1653
1654 \subsection{Graphical Output}
1655 \label{figuregen}
1656 \parbox[c]{4in}{Jalview allows alignments figures to be exported in three different formats, each of which is suited to a particular purpose. Image export is {\sl via} the {\sl File $\Rightarrow$ Export Image $\Rightarrow$ \ldots } alignment window menu option. }
1657 \parbox[c]{2in}{\centerline{\includegraphics[width=1.25in]{images/image.pdf}}}
1658
1659 \subsubsection{HTML}
1660
1661 \parbox[c]{3in}{HTML is the format used by web pages. Jalview outputs the alignment as an HTML table with all the colours and fonts as seen. Any additional annotation will also be embedded as sensitive areas on the page, such as URL links for each sequence's ID label. This file can then be viewed directly with any web browser. Each residue is placed in an individual table cell. Unwrapped alignments will produce a very wide page.}
1662 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_html.pdf}}}
1663
1664 \subsubsection{EPS}
1665 \parbox[c]{3in}{EPS is Encapsulated Postscript. {\bf It is the format of choice
1666 for publications and posters} as it gives the highest quality output of any of
1667 the image types. It can be scaled to any size, so will still look good on an A0
1668 poster.
1669 This format can be read by most good presentation and graphics packages such as Adobe Illustrator or Inkscape.
1670 }
1671 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_eps.pdf}} \par \centerline{Zoom Detail of EPS image.}}
1672
1673 \subsubsection{PNG}
1674 \parbox[c]{3in}{
1675 PNG is Portable Network Graphics. This output option produces an image that can be easily included in web pages and incorporated in presentations using e.g. Powerpoint or Open Office. It is a bitmap image so does not scale and is unsuitable for use on posters, or in publications.
1676
1677 For submission of alignment figures to journals, please use EPS\footnote{If the journal complains, {\em insist}.}.
1678 }
1679 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_png.pdf}} \par \centerline{Zoom Detail of PNG image.}}
1680  \exercise{Graphical Output}{
1681 \exstep{Load the example Jalview Jar file in Exercise \ref{exscreen}. 
1682 Customise it how you wish but leave it unwrapped. 
1683 Select {\sl File $\Rightarrow$ Export Image $\Rightarrow$ HTML} from the alignment menu. 
1684 Save the file and open it in your favoured web browser.  }
1685 \exstep{Wrap the alignment and export the image to HTML again. Compare the two
1686 images. (Note that the exported image matches the format displayed in the
1687 alignment window but {\bf annotations are not exported}).}
1688 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image $\Rightarrow$ PNG} menu option. 
1689 Open the file in an image viewer that allows zooming such as Paint or Photoshop (Windows), or Preview (Mac OS X) and zoom in. 
1690 Notice that the image is a bitmap and it becomes pixelated very quickly. 
1691 (Note that the {\bf annotation lines are included} in the image.)}
1692 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image
1693 $\Rightarrow$ EPS} menu option. Open the file in a suitable program such as
1694 Photoshop, Illustrator, Inkscape, Ghostview, Powerpoint (Windows), or
1695 Preview (Mac OS X). Zoom in and note that the image has near-infinite
1696 resolution.} }
1697
1698 \chapter{Features and Annotation}
1699 \label{annotation}
1700 \section{Features and Annotation}
1701 \label{featannot}
1702 Features and annotations are additional information that is overlaid on the sequences and the alignment. Generally speaking, annotations are associated with columns in the alignment. Features are associated with specific residues in the sequence. 
1703
1704 Annotations are shown below the alignment in the annotation panel, and often reflect properties of the alignment as a whole.  The Conservation, Consensus and Quality scores are examples of dynamic annotation, so as the alignment changes, they change along with it. Conversely, sequence features are properties of the individual sequences, so they do not change with the alignment, but are shown mapped on to specific residues within the alignment. 
1705
1706 Features and annotation can be interactively created, or retrieved from external
1707 data sources. DAS (the Distributed Annotation System) is the primary source of
1708 sequence features, whilst webservices like JNet (see \ref{jpred} above) can be used to analyse a 
1709 given sequence or alignment and generate annotation for it.
1710
1711 \section{Importing Features from Databases}
1712 \label{featuresfromdb}
1713 Jalview supports feature retrieval from public databases either directly or {\sl
1714 via} the Distributed Annotation System (DAS\footnote{http://www.biodas.org/}).
1715 It includes built in parsers for Uniprot and ENA (or EMBL) records retrieved
1716 from the EBI. Sequences retrieved from these sources using the sequence fetcher (see
1717 Section \ref{fetchseq}) will already possess features.
1718
1719 \subsection{Sequence Database Reference Retrieval}
1720 \label{fetchdbrefs}
1721 Jalview maintains a list of external database references for each sequence in
1722 an alignment. These are listed in a tooltip when the mouse is moved over the
1723 sequence ID when the {\sl View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$
1724 Show Database Refs } option is enabled. Sequences retrieved using the sequence
1725 fetcher will always have at least one database reference, but alignments
1726 imported from an alignment file generally have no database references.
1727
1728 \subsubsection{Database References and Sequence Coordinate Systems}
1729
1730 Jalview displays features in the local sequence's coordinate system which is
1731 given by its `start' and `end'. Any sequence features on the sequence will be
1732 rendered relative to the sequence's start position. If the start/end positions
1733 do not match the coordinate system from which the features were defined, then
1734 the features will be displayed incorrectly.
1735
1736 \subsubsection{Viewing and Exporting a Sequence's Database Annotation}
1737
1738 You can export all the database cross references and annotation terms shown in
1739 the sequence ID tooltip for a sequence by right-clicking and selecting the {\sl
1740 [Sequence ID] $\Rightarrow$ Sequence details \ldots} option from the popup menu.
1741 A similar option is provided in the {\sl Selection} sub-menu allowing you to
1742 obtain annotation for the sequences currently selected. 
1743
1744 \parbox[l]{3.4in}{
1745 The {\sl Sequence Details
1746 \ldots} option will open a window containing the same text as would be shown in
1747 the tooltip window, including any web links associated with the sequence. The
1748 text is HTML, and options on the window allow the raw code to be copied and
1749 pasted into a web page.}
1750 \parbox[c]{3in}{
1751 \centerline{\includegraphics[width=2.2in]{images/seqdetailsreport.pdf}}}
1752
1753 \subsubsection{Automatically Discovering a Sequence's Database References}
1754 Jalview includes a function to automatically verify and update each sequence's
1755 start and end numbering against any of the sequence databases that the {\sl
1756 Sequence Fetcher} has access to. This function is accessed from the {\sl
1757 Webservice $\Rightarrow$ Fetch DB References} sub-menu in the Alignment
1758 window. This menu allows you to query either the set of {\sl Standard
1759 Databases}, which includes EMBL, Uniprot, the PDB, and the currently selected
1760 DAS sequence sources, or just a specific datasource from one of the submenus.
1761 When one of the entries from this menu is selected, Jalview will use the ID
1762 string from each sequence in the alignment or in the currently selected set to
1763 retrieve records from the external source. Any sequences that are retrieved are
1764 matched against the local sequence, and if the local sequence is found to be a
1765 sub-sequence of the retrieved sequence then the local sequence's start/end
1766 numbering is updated.  A new database reference mapping is created, mapping the
1767 local sequence to the external database, and the local sequence inherits any
1768 additional annotation retrieved from the database sequence.
1769
1770 The database retrieval process terminates when a valid mapping is found for a
1771 sequence, or if all database queries failed to retrieve a matching sequence.
1772 Termination is indicated by the disappearance of the moving progress indicator
1773 on the alignment window. A dialog box may be shown once it completes which
1774 lists sequences for which records were found, but the sequence retrieved from
1775 the database did not exactly contain the sequence given in the alignment (the
1776 {\sl ``Sequence not 100\% match'' dialog box}).
1777
1778 \exercise{Retrieving Database References}{
1779 \exstep{Load the example alignment at http://www.jalview.org/tutorial/alignment.fa}
1780 \exstep{Verify that there are no database references for the sequences by first
1781 checking that the {\sl View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$ Show
1782 Database Refs} option is selected, and then mousing over each sequence's ID.}
1783 \exstep{Use the {\sl Webservice $\Rightarrow$ Fetch DB References} menu option to retrieve database IDs for the sequences.}
1784 \exstep{Examine the tooltips for each sequence in the alignment as the retrieval progresses - note the appearance of new database references.}
1785 \exstep{Once the process has finished, save the alignment as a Jalview Project.}
1786 \exstep{Now close all the windows and open the project again, and verify that the database references and sequence features are still present on the alignment}
1787
1788 \exstep{View the {\sl Sequence details \ldots} report for the FER1\_SPIOL sequence and for the whole alignment. Which sequences have web links associated with them ?}
1789
1790 }
1791
1792 \subsection{Retrieving Features {\sl via} DAS}
1793 \label{dasfretrieval}
1794 Jalview includes a client to retrieve features from DAS annotation servers. To
1795 retrieve features, select {\sl View $\Rightarrow$ Feature Settings\ldots} from the alignment window menu. Select the {\sl DAS Settings} tab in the Sequence Feature Settings Window (Figure \ref{das}). A list of DAS sources compiled from the currently configured DAS registry\footnote{By default, this will be the major public DAS server registry maintained by the Sanger Institute: http://www.dasregistry.org} is shown in the left hand pane. Highlighting an entry on the left brings up information about that source in the right hand panel.
1796
1797 \begin{figure}[htbp]
1798 \begin{center}
1799 \includegraphics[width=2.5in]{images/das1.pdf}
1800 \includegraphics[width=2.5in]{images/das2.pdf}
1801 \caption{{\bf Retrieving DAS annotations.} DAS features are retrieved using the {\sl DAS Settings} tab (left) and their display customised using the {\sl Feature Settings} tab (right).}
1802 \label{das}
1803 \end{center}
1804 \end{figure}
1805
1806 Select appropriate DAS sources as required then click on {\sl Fetch DAS
1807 Features}. If you know of additional sources not listed in the configured
1808 registry, then you may add them with the {\sl Add Local Source} button. Use
1809 the {\sl Authority},{\sl Type}, and {\sl Label} filters to restrict the list
1810 of sources to just those that will return features for the sequences in the
1811 alignment.
1812
1813 Following DAS feature retrieval, the {\sl Feature Settings} panel takes on a
1814 slightly different appearance (Figure \ref{das} (right)). Each data source is
1815 listed and groups of features from one data source can be selected/deselected
1816 by checking the labelled box at the top of the panel.
1817
1818 \exercise{Retrieving Features with DAS}{
1819 \label{dasfeatretrexcercise}
1820 \exstep{Load the alignment at
1821 \textsf{http://www.jalview.org/tutorial/alignment.fa}.  Select {\sl View
1822 $\Rightarrow$ Feature Settings \ldots} from the alignment window menu. Select
1823 the {\sl DAS Settings} tab. A long list of available DAS sources is listed. 
1824 Select a small number, eg Uniprot, DSSP, signalP and netnglyc. Click. 
1825 A window may prompt whether you wish Jalview to fetch DAS features. Click {\sl
1826 Yes}.
1827 Jalview will start retrieving features. As features become available they will be mapped onto the alignment. } 
1828 \exstep{If Jalview is taking too long to retrieve features, the process can be cancelled with the {\sl Cancel Fetch} button. 
1829 Rolling the mouse cursor over the sequences reveals a large number of features annotated in the tool tip. 
1830 Close the Sequence Feature Settings window. }
1831 \exstep{Move the mouse over the sequence ID panel. 
1832 Non-positional features such as literature references and protein localisation predictions are given in the tooltip, below any database cross references associated with the sequence.}
1833 \exstep{Search through the alignment to find a feature with a link symbol next to it. 
1834 Right click to bring up the alignment view popup menu, and find a corresponding entry in the {\sl Link } sub menu. }
1835 % TODO this doesn't work ! \includegraphics[width=.3in]{images/link.pdf}
1836
1837 \exstep{
1838 Select {\sl View $\Rightarrow$ Feature Settings\ldots} to reopen the Feature Settings window. All the loaded feature types should now be displayed. Those at the top of the list are drawn on top of those below, obscuring them in the alignment view where they overlap. Move the feature settings window so that the alignment is visible and uncheck some of the feature types by clicking the tick box in the display column. Observe how the alignment display changes. Note that unselected feature types do not appear in the tool tip.
1839 }
1840 \exstep{Reorder the features by dragging feature types up and down the order in the Feature Settings panel. e.g. Click on {\sl CHAIN} then move the mouse downwards to drag it below {\sl DOMAIN}. Note that {\sl DOMAIN} is now shown on top of {\sl CHAIN} in the alignment window. Drag {\sl METAL} to the top of the list. Observe how the cysteine residues are now highlighted as they have a {\sl METAL} feature associated with them.
1841 }
1842
1843 \exstep{Press the {\sl Optimise Order} button. The features will be ordered according to increasing length, placing features that annotate shorter regions of sequence higher on the display stack.}
1844
1845 \exstep{Select {\sl File $\Rightarrow$ Export Features\ldots} from the Alignment window. You can choose to export the retrieved features as a GFF file, or Jalview's own Features format. 
1846 % TODO: describe working with features files and GFF
1847 }
1848 }
1849
1850 \subsubsection{The Fetch Uniprot IDs Dialog Box}
1851 \label{discoveruniprotids}
1852 If any sources are selected which refer to Uniprot coordinates as their reference system, 
1853 then you may be asked if you wish to retrieve Uniprot IDs for your sequence. Pressing OK instructs Jalview to verify the sequences against Uniprot records retrieved using the sequence's ID string. This operates in much the same way as the {\sl Web Service $\Rightarrow$ Fetch Database References } function described in Section \ref{fetchdbrefs}. If a sequence is verified, then the start/end numbering will be adjusted to match the Uniprot record to ensure that features retrieved from the DAS source are rendered at the correct position. 
1854
1855 \subsubsection{Rate of Feature Retrieval}
1856 Feature retrieval can take some time if a large number of sources is selected and if the alignment 
1857 contains a large number of sequences. This is because Jalview only queries a particular DAS source with one sequence at a time, to avoid overloading it.  As features are retrieved, they are immediately added to the current alignment view. The retrieved features are shown on the sequence and can be customised as described previously.
1858
1859
1860 \subsection{Colouring Features by Score or Description
1861 Text}
1862 \label{featureschemes}
1863 Sometimes, you may need to visualize the differences in information carried by
1864 sequence features of the same type. This is most often the case when features
1865 of a particular type are the result of a specific type of database query or calculation. Here, they may also carry information within their textual description, or most commonly for calculations, a score related to the property being investigated. Jalview can shade sequence
1866 features using a graduated colourscheme in order to highlight these variations.
1867 In order to apply a graduated scheme to a feature type, select the `Graduated
1868 colour' entry in the Sequence {\sl Feature Type}'s popup menu, which is opened by
1869 right-clicking the {\sl Feature Type} or {\sl Color} in the {\sl Sequence Feature Settings} dialog box. Two types
1870 of colouring styles are currently supported: the default is quantitative
1871 colouring, which shades each feature based on its score, with the highest
1872 scores receiving the `Max' colour, and the lowest scoring features coloured
1873 with the `Min' colour. Alternately, you can select the `Colour by label'
1874 option to create feature colours according to the description text associated
1875 with each feature. This is useful for general feature types - such as
1876 Uniprot's `DOMAIN' feature - where the actual type of domain is given in the
1877 feature's description.
1878
1879 Graduated feature colourschemes can also be used to exclude low or
1880 high-scoring features from the alignment display. This is done by choosing your
1881 desired threshold type (either above or below), using the drop-down menu in the
1882 dialog box. Then, adjust the slider or enter a value in the text box to set the
1883 threshold for displaying this type of feature.
1884
1885 The feature settings dialog box allows you to toggle between a graduated and
1886 simple feature colourscheme using the pop-up menu for the feature type. When a
1887 graduated scheme is applied, it will be indicated in the colour column for
1888 that feature type - with coloured blocks or text to indicate the colouring
1889 style and a greater than ($>$) or less than ($<$) symbol to indicate when a
1890 threshold has been defined.
1891
1892 \subsection{Using Features to Re-order the Alignment}
1893 \label{featureordering}
1894 The presence of sequence features on certain sequences or in a particular
1895 region of an alignment can quantitatively identify important trends in
1896 the aligned sequences. In this case, it is more useful to
1897 re-order the alignment based on the number of features or their associated scores, rather than simply re-colour the aligned sequences. The sequence feature settings
1898 dialog box provides two buttons: `Seq sort by Density' and `Seq sort by
1899 Score', that allow you to reorder the alignment according to the number of
1900 sequence features present on each sequence, and also according to any scores
1901 associated with a feature. Each of these buttons uses the currently displayed
1902 features to determine the ordering, but
1903 if you wish to re-order the alignment using a single type of feature, then you can do this from the {\sl Feature Type}'s
1904 popup menu. Simply right-click the type's style in the Sequence Feature Settings dialog
1905 box, and select one of the {\sl Sort by Score} and {\sl Sort by Density}
1906 options to re-order the alignment. Finally, if a specific region is selected,
1907 then only features found in that region of the alignment will be used to
1908 create the new alignment ordering.
1909 % \exercise{Shading and Sorting Alignments using Sequence Features}{
1910 % \label{shadingorderingfeatsex}
1911
1912 % This exercise is currently not included in the tutorial because no DAS servers
1913 % currently exist that yield per-residue features for any Uniprot sequence. 
1914
1915 % \exstep{Re-load the alignment from \ref{dasfeatretrexcercise}.
1916 % }
1917 % \exstep{Open the
1918 % feature settings panel, and, after first clearing the current
1919 % selection, press the {\em Seq Sort by Density} button a few times.}
1920 % \exstep{Use the DAS fetcher to retrieve the Kyte and Doolittle Hydrophobicity
1921 % scores for the protein sequences in the alignment.
1922 % {\sl Hint: the nickname for the das source is `KD$\_$hydrophobicity'.}}
1923 % \exstep{Change the feature settings so only the hydrophobicity features are
1924 % displayed. Mouse over the annotation and also export and examine the GFF and
1925 % Jalview features file to better understand how the hydrophobicity measurements
1926 % are recorded.}
1927 % \exstep{Apply a {\sl Graduated Colour} to the hydrophobicity annotation to
1928 % reveal the variation in average hydrophobicity across the alignment.}
1929 % \exstep{Select a range of alignment columns, and use one of the sort by feature buttons to order the alignment according to that region's average
1930 % hydrophobicity.}
1931 % \exstep{Save the alignment as a project, for use in exercise
1932 % \ref{threshgradfeaturesex}.} }
1933
1934 % \exercise{Shading alignments with combinations of graduated feature
1935 % colourschemes}{
1936 % \label{threshgradfeaturesex}
1937 % \exstep{Reusing the annotated alignment from exercise
1938 % \ref{shadingorderingfeatsex}, experiment with the colourscheme threshold to
1939 % highlight the most, or least hydrophobic regions. Note how the {\sl Colour} icon for the {\sl Feature Type} changes when you change the threshold type and press OK.}
1940 % \exstep{Change the colourscheme so
1941 % that features at the threshold are always coloured grey, and the most
1942 % hydrophobic residues are coloured red, regardless of the threshold value
1943 % ({\em hint - there is a switch on the dialog to do this for you}).}
1944 % \exstep{Enable the Uniprot {\em chain} annotation in the feature settings
1945 % display and re-order the features so it is visible under the hydrophobicity
1946 % annotation.}
1947 % \exstep{Apply a {\sl Graduated Colour} to the {\em chain}
1948 % annotation so that it distinguishes the different canonical names associated
1949 % with the mature polypeptide chains.}
1950 % \exstep{Export the alignment's sequence features using the Jalview and GFF file formats, to see how the different types of graduated feature
1951 % colour styles are encoded. }
1952 % }
1953
1954 \subsection{Creating Sequence Features}
1955 Sequence features can be created simply by selecting the area in a sequence (or sequences) to form the feature and selecting {\sl Selection $\Rightarrow$ Create Sequence Feature } from the right-click context menu (Figure \ref{features}). A dialogue box allows the user to customise the feature with respect to name, group, and colour. The feature is then associated with the sequence. Moving the mouse over a residue associated with a feature brings up a tool tip listing all features associated with the residue.
1956
1957 \begin{figure}[htbp]
1958 \begin{center}
1959 \includegraphics[width=2in]{images/feature1.pdf}
1960 \includegraphics[width=2.5in]{images/feature2.pdf}
1961 \includegraphics[width=1.5in]{images/feature3.pdf}
1962 \caption{{\bf Creating sequence features.} Features can readily be created from selections via the context menu and are then displayed on the sequence. }
1963 \label{features}
1964 \end{center}
1965 \end{figure}
1966
1967 Creation of features from a selection spanning multiple sequences results in the creation of one feature per sequence. 
1968 Each feature remains associated with its own sequence.
1969
1970 \subsection{Customising Feature Display}
1971
1972 Feature display can be toggled on or off by selecting the {\sl View
1973 $\Rightarrow$ Show Sequence Features} menu option. When multiple features are
1974 present it is usually necessary to customise the display. Jalview allows the
1975 display, colour, rendering order and transparency of features to be modified
1976 {\sl via} the {\sl View $\Rightarrow$ Feature Settings\ldots} menu option. This
1977 brings up a dialogue window (Figure \ref{custfeat}) which allows the
1978 visibility of individual feature types to be selected, colours changed (by
1979 clicking on the colour of each sequence feature type) and the rendering order
1980 modified by dragging feature types to a new position in the list. Dragging the
1981 slider alters the transparency of the feature rendering. The Feature
1982 Settings dialog also includes functions for more advanced feature shading
1983 schemes and buttons for sorting the alignment according to the distribution of
1984 features. These capabilities are described further in sections
1985 \ref{featureschemes} and \ref{featureordering}.
1986
1987 \begin{figure}[htbp]
1988 \begin{center}
1989 \includegraphics[width=4in]{images/features4.pdf}
1990 \caption{{\bf Multiple sequence features.} An alignment with JPred secondary structure prediction annotation below it, and many sequence features overlaid onto the aligned sequences. The tooltip lists the features annotating the residue below the mouse-pointer.}
1991 \end{center}
1992 \end{figure}
1993
1994 \begin{figure}[htbp]
1995 \begin{center}
1996 \includegraphics[width=4in]{images/features5.pdf}
1997 \caption{{\bf Customising sequence features.} Features can be recoloured, switched on or off and have the rendering order changed. }
1998 \label{custfeat}
1999 \end{center}
2000 \end{figure}
2001
2002 \subsection{Sequence Feature File Formats}
2003
2004 Jalview supports the widely used GFF tab delimited format\footnote{see
2005 http://www.sanger.ac.uk/resources/software/gff/spec.html} and its own Jalview
2006 Features file format for the import of sequence annotation. Features and
2007 alignment annotation are also extracted from other formats such as Stockholm,
2008 and AMSA. URL links may also be attached to features. See the online
2009 documentation for more details of the additional capabilities of the Jalview
2010 features file.
2011
2012 \exercise{Creating Features}{
2013 \exstep{Open the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
2014 We know that the Cysteine residues at columns 97, 102, 105 and 135 are involved in 
2015 iron binding so we will create them as features. Navigate to column 97, sequence 1. 
2016 Select the entire column by clicking in the ruler bar. Then right-click on the selection 
2017 to bring up the context menu and select {\sl Selection $\Rightarrow$ Create Sequence Feature}. 
2018 A dialogue box will appear.
2019 }
2020 \exstep{
2021 Enter a suitable Sequence Feature Name  (e.g. ``Iron binding site") in the
2022 appropriate box. Click on the Feature Colour bar to change the colour if
2023 desired, add a short description (``One of four Iron binding Cysteines") and press OK. The features will then appear on the sequences. } \exstep{Roll the mouse cursor over the new features. Note that the position given in the tool tip is the residue number, not the column number.  To demonstrate that there is one feature per sequence, clear all selections by pressing [ESC] then insert a gap in sequence 3 at column 95. Roll the mouse over the features and you will see that the feature has moved with the sequence. Delete the gap you created.
2024 }
2025 \exstep{
2026 Add a similar feature to column 102. When the feature dialogue box appears, clicking the Sequence Feature Name box brings up a list of previously described features. Using the same Sequence Feature Name allows the features to be grouped.}
2027 \exstep{Select {\sl View $\Rightarrow$ Feature Settings\ldots} from the
2028 alignment window menu. The Sequence Feature Settings window will appear. Move
2029 this so that you can see the features you have just created. Click the check
2030 box for ``Iron binding site"  under {\sl Display} and note that display of this
2031 feature type is now turned off. Click it again and note that the features are
2032 now displayed. Close the sequence feature settings box by clicking OK or
2033 Cancel.} }
2034
2035 \subsection{Creating User Defined Annotation}
2036
2037 Annotations are properties that apply to the alignment as a whole and are visualized on rows in the annotation panel.
2038 To create a new annotation row, right click on the annotation label panel and select the {\sl Add New Row} menu option (Figure \ref{newannotrow}). A dialogue box appears. Enter the label to use for this row and a new row will appear.
2039
2040 \begin{figure}[htbp]
2041 \begin{center}
2042 \includegraphics[width=1.3in]{images/annots1.pdf}
2043 \includegraphics[width=2in]{images/annots2.pdf}
2044 \caption{{\bf Creating a new annotation row.} Annotation rows can be reordered by dragging them to the desired place.}
2045 \label{newannotrow}
2046 \end{center}
2047 \end{figure}
2048
2049 To create a new annotation, first select all the positions to be annotated on the appropriate row. Right-clicking on this selection brings up the context menu which allows the insertion of graphics for secondary structure ({\sl Helix} or {\sl Sheet}), text {\sl Label} and the colour in which to present the annotation (Figure \ref{newannot}). On selecting {\sl Label} a dialogue box will appear, requesting the text to place at that position. After the text is entered, the selection can be removed and the annotation becomes clearly visible\footnote{When annotating a block of positions, the text can be partly obscured by the selection highlight. Pressing the  [ESC] key clears the selection and the label is then visible.}. Annotations can be coloured or deleted as desired.
2050
2051 \begin{figure}[htbp]
2052 \begin{center}
2053 \includegraphics[width=2in]{images/annots3.pdf}
2054 \includegraphics[width=2in]{images/annots4.pdf}
2055 \includegraphics[width=2in]{images/annots5.pdf}
2056 \caption{{\bf Creating a new annotation.} Annotations are created from a selection on the annotation row and can be coloured as desired.}
2057 \label{newannot}
2058 \end{center}
2059 \end{figure}
2060
2061 \exercise{Annotating Alignments}{
2062 \exstep{Load the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
2063 Right-click on the {\sl Conservation} annotation row to
2064 bring up the context menu and select {\sl Add New Row}. A dialogue box will appear asking for  {\sl Label for annotation}. 
2065 Enter ``Iron binding site" and click OK. A new, empty, row appears.
2066 }
2067 \exstep{
2068 Navigate to column 97. Move down and on the new annotation row called
2069 ``Iron binding site, select column 97.
2070 Right click at this selection and select {\sl Label} from the context menu.
2071 Enter ``Fe" in the box and click OK. Right-click on the selection again and select {\sl Colour}. 
2072 Choose a colour from the colour chooser dialogue 
2073 and click OK. Press [ESC] to remove the selection.
2074 }
2075 \exstep{ Select columns 70-77 on the annotation row. Right-click and choose {\sl Sheet} from the
2076  context menu. You will be prompted for a label. Enter ``B" and press OK. A new line showing the 
2077  sheet as an arrow appears. The colour of the label can be changed but not the colour of the sheet 
2078  arrow. 
2079 }
2080 \exstep{Right click on the title text of annotation row that you just created. 
2081 Select {\sl Export Annotation} and, in the {\bf Export Annotation} dialog box that will open, select the Jalview format and click 
2082 the [To Textbox] button. 
2083
2084 The format for this file is given in the Jalview help. Press [F1] to open it, and find 
2085 the ``Annotations File Format'' entry in the ``Alignment Annotations'' section of the contents 
2086 pane. }
2087
2088 \exstep{Export the file to a text editor and edit the file to change the name of the annotation 
2089 row. Save the file and drag it onto the alignment view.}
2090 \exstep{Try to add an additional helix somewhere along the row by editing the file and 
2091 re-importing it.
2092 {\sl Hint: Use the {\bf Export Annotation} function to view what helix annotation looks like in 
2093 a Jalview annotation file.}}
2094 \exstep{Use the {\sl Alignment Window $\Rightarrow$ File $\Rightarrow$ Export Annotations...} 
2095 function to export all the alignment's annotation to a file.}
2096 \exstep{Open the exported annotation in a text editor, and use the {\bf Annotation File Format} 
2097 documentation to modify the style of the Conservation, Consensus and Quality annotation rows so 
2098 they appear as several lines on a single line graph.
2099 {\sl Hint: You need to change the style of annotation row in the first field of the annotation 
2100 row entry in the file, and create an annotation row grouping to overlay the three quantitative 
2101 annotation rows.}
2102 }
2103 \label{viewannotfileex}\exstep{Recover or recreate the secondary structure
2104 prediction that you made in exercise \ref{secstrpredex}. Use the {\sl File $\Rightarrow$ Export 
2105 Annotation} function to view the Jnet secondary structure prediction annotation row. Note the 
2106 {\bf SEQUENCE\_REF} statements surrounding the row specifying the sequence association for the 
2107 annotation. } }
2108
2109 \chapter{Multiple Sequence Alignment}
2110 \label{msaservices}
2111 Sequences can be aligned using a range of algorithms provided by JABA web
2112 services. These include ClustalW\footnote{{\sl ``CLUSTAL W: improving the
2113 sensitivity of progressive multiple sequence alignment through sequence
2114 weighting, position specific gap penalties and weight matrix choice."} Thompson
2115 JD, Higgins DG, Gibson TJ (1994) {\sl  Nucleic Acids Research} {\bf 22},
2116 4673-80}, Muscle\footnote{{\sl ``MUSCLE: a multiple sequence alignment method
2117 with reduced time and space complexity"} Edgar, R.C.
2118 (2004) {\sl BMC Bioinformatics} {\bf 5}, 113},  MAFFT\footnote{{\sl ``MAFFT: a
2119 novel method for rapid multiple sequence alignment based on fast Fourier
2120 transform"}  Katoh, K., Misawa, K., Kuma, K. and Miyata, T. (2002) {\sl Nucleic
2121 Acids Research} {\bf 30}, 3059-3066.  and {\sl ``MAFFT version 5:
2122 improvement in accuracy of multiple sequence alignment"} Katoh, K., Kuma, K.,
2123 Toh, H. and Miyata, T. (2005) {\sl Nucleic Acids Research} {\bf 33}, 511-518.},
2124 ProbCons,\footnote{PROBCONS: Probabilistic Consistency-based Multiple Sequence
2125 Alignment.
2126 Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S.
2127 (2005) {\sl Genome Research} {\bf 15} 330-340.} T-COFFEE\footnote{T-Coffee:
2128 A novel method for multiple sequence alignments. (2000) Notredame, Higgins and
2129 Heringa {\sl JMB} {\bf 302} 205-217} and Clustal Omega.\footnote{Fast, scalable
2130 generation of high-quality protein multiple sequence alignments using Clustal
2131 Omega. Sievers F, Wilm A, Dineen DG, Gibson TJ, Karplus K, Li W, Lopez R,
2132 McWilliam H, Remmert M, Soding J, Thompson JD, Higgins DG (2011) {\sl Molecular
2133 Systems Biology} {\bf 7} 539
2134 \href{http://dx.doi.org/10.1038/msb.2011.75}{doi:10.1038/msb.2011.75}} Of these,
2135 T-COFFEE is the slowest, but also the most accurate. ClustalW is historically
2136 the most widely used. Muscle is faster than ClustalW and probably the most
2137 accurate for smaller alignments and MAFFT is probably the best for large
2138 alignments, however {\bf Clustal Omega}, which was released in 2011, is
2139 arguably the fastest and most accurate tool for protein multiple alignment.
2140
2141
2142 To run an alignment web service, select the appropriate method from the {\sl
2143 Web Service $\Rightarrow$  Alignment $\Rightarrow$ \ldots} submenu (Figure
2144 \ref{webservices}). For each service you may either perform an alignment with
2145 default settings, use one of the available presets, or customise the parameters
2146 with the `{\sl Edit and Run ..}' dialog box. Once the job is submitted, a
2147 progress window will appear giving information about the job and any errors that
2148 occur. After successful completion of the job, a new window is opened with the
2149 results, in this case an alignment. By default, the new alignment will be
2150 ordered in the same way as the input sequences; however, many alignment programs
2151 re-order the input to place homologous sequences close together. This ordering
2152 can be recovered using the `Original ordering' entry within the {\sl Calculate
2153 $\Rightarrow$ Sort } sub menu.
2154
2155 \begin{figure}[htbp]
2156 \begin{center}
2157 \parbox[c]{1.5in}{\includegraphics[width=1.5in]{images/ws1.pdf}}
2158 \parbox[c]{2.5in}{\includegraphics[width=2.5in]{images/ws2.pdf}}
2159 \parbox[c]{2in}{\includegraphics[width=2in]{images/ws3.pdf}}
2160 \caption{{\bf Multiple alignment via web services} The appropriate method is
2161 selected from the menu (left), a status box appears (centre), and the results
2162 appear in a new window (right).}
2163 \label{webservices}
2164 \end{center}
2165 \end{figure}
2166
2167 \subsubsection{Realignment}
2168
2169 The re-alignment option is currently only supported by ClustalW and Clustal
2170 Omega. When performing a re-alignment, Jalview submits the current selection to
2171 the alignment service complete with any existing gaps. This approach is useful
2172 when one wishes to align additional sequences to an existing alignment without
2173 any further optimisation to the existing alignment. The re-alignment service
2174 provided by ClustalW in this case is effectively a simple form of profile
2175 alignment.
2176
2177 \subsubsection{Alignments of Sequences that include Hidden Regions}
2178
2179 If the view or selected region that is submitted for alignment contains hidden
2180 regions, then {\bf only the visible sequences will be submitted to the service}.
2181 Furthermore, each contiguous segment of sequences will be aligned independently
2182 (resulting in a number of alignment `subjobs' appearing in the status window).
2183 Finally, the results of each subjob will be concatenated with the hidden regions
2184 in the input data prior to their display in a new window. This approach ensures
2185 that 1) hidden column boundaries in the input data are preserved in the
2186 resulting alignment - in a similar fashion to the constraint that hidden columns
2187 place on alignment editing (see Section \ref{lockededits} and 2) hidden
2188 columns can be used to preserve existing parts of an alignment whilst the
2189 visible parts are locally refined.
2190
2191 \exercise{Multiple Sequence Alignment}{
2192 \exstep{ Close all windows and open the alignment at {\sf
2193 http://www.jalview.org/tutorial/unaligned.fa}.  Select {\sl
2194 Web Service $\Rightarrow$ Alignment $\Rightarrow$ Muscle with Defaults}. 
2195 A window will open giving the job status. After a short time, a second window will open
2196  with the results of the alignment.} 
2197  \exstep{Return to the first sequence alignment window by clicking on 
2198  the window, and repeat using Clustal and MAFFT (from the {\sl Web
2199  Service $\Rightarrow$ Alignment} menu) on the same initial alignment. Compare them and 
2200  you should notice small differences. }
2201 \exstep{Select the last three sequences in the MAFFT alignment, and de-align them 
2202 with {\sl Edit $\Rightarrow$ Remove All Gaps}. Press [ESC] to deselect them and then 
2203 submit the view for re-alignment with Clustal.}
2204 \exstep{Use [CTRL]-Z to recover the alignment of the last three sequences in the MAFFT alignment. 
2205 Once the Clustal re-alignment has completed, compare the results of re-alignment of the 
2206 three sequences with their alignment in the original MAFFT result.}
2207 \exstep{Select columns 60 to 125 in the original MAFFT alignment and hide them. 
2208 Select {\sl Web Services $\Rightarrow$ Alignment $\Rightarrow$ Mafft with Defaults} to 
2209 submit the visible portion of the alignment to MAFFT. When the web service job pane appears, 
2210 note that there are now two alignment job status panes shown in the window.}
2211 \exstep{When the MAFFT job has finished, compare the alignment of the N-terminal visible 
2212 region in the result with the corresponding region of the original alignment. If you wish, 
2213 select and hide a few more columns in the N-terminal region, and submit the alignment to the 
2214 service again and explore the effect of local alignment on the non-homologous parts of the 
2215 N-terminal region.} 
2216 }
2217
2218
2219 \subsection{Customising the Parameters used for Alignment}
2220
2221 JABA web services allow you to vary the parameters used when performing a
2222 bioinformatics analysis. For JABA alignment services, this means you are
2223 usually able to modify the following types of parameters:
2224 \begin{list}{$\bullet$}{}
2225 \item Amino acid or nucleotide substitution score matrix
2226 \item Gap opening and widening penalties
2227 \item Types of distance metric used to construct guide trees
2228 \item Number of rounds of re-alignment or alignment optimisation  
2229 \end{list}
2230
2231
2232 \subsubsection{Getting Help on the Parameters for a Service}
2233 Each parameter available for a method usually has a short description, which
2234 Jalview will display as a tooltip, or as a text pane that can be opened under
2235 the parameter's controls. In the parameter shown in Figure
2236 \ref{clustalwparamdetail}, the description was opened by selecting the button on the left hand side. Online help for the
2237 service can also be accessed, by right clicking the button and selecting a URL
2238 from the pop-up menu that will open.
2239
2240 \begin{figure}[htbp]
2241 \begin{center}
2242 \includegraphics[width=2.5in]{images/clustalwparamdetail.pdf}
2243 \caption{{\bf ClustalW parameter slider detail}. From the ClustalW {\sl Clustal $\Rightarrow$ Edit settings and run ...} dialog box. }
2244 \label{clustalwparamdetail}
2245 \end{center}
2246 \end{figure} 
2247
2248 \subsection{Alignment Presets}
2249 The different multiple alignment algorithms available from JABA vary greatly in
2250 the number of adjustable parameters, and it is often difficult to identify what
2251 are the best values for the sequences that you are trying to align. For these
2252 reasons, each JABA service may provide one or more presets -- which are
2253 pre-defined sets of parameters suited for particular types of alignment
2254 problem. For instance, the Muscle service provides the following presets:
2255 \begin{list}{$\bullet$}{}
2256 \item Large alignments (balanced)
2257 \item Protein alignments (fastest speed)
2258 \item Nucleotide alignments (fastest speed)
2259 \end{list}
2260
2261 The presets are displayed in the JABA web services submenu, and can also be
2262 accessed from the parameter editing dialog box, which is opened by selecting
2263 the `{\sl Edit settings and run ...}' option from the web services menu. If you have used
2264 a preset, then it will be mentioned at the beginning of the job status file shown
2265 in the web service job progress window.
2266
2267 \subsubsection{Alignment Service Limits}
2268 Multiple alignment is a computationally intensive calculation. Some JABA server
2269 services and service presets only allow a certain number of sequences to be
2270 aligned. The precise number will depend on the server that you are using to
2271 perform the alignment. Should you try to submit more sequences than a service
2272 can handle, then an error message will be shown informing you of the maximum
2273 number allowed by the server.
2274
2275 \subsection{User Defined Presets}
2276 Jalview allows you to create your own presets for a particular service. To do
2277 this, select the `{\sl Edit settings and run ...}' option for your service,
2278 which will open a parameter editing dialog box like the one shown in Figure
2279 \ref{jwsparamsdialog}.
2280
2281 The top row of this dialog allows you to browse the existing presets, and
2282 when editing a parameter set, allows you to change its nickname. As you
2283 adjust settings, buttons will appear at the top of the parameters dialog that
2284 allow you to Revert or Update the currently selected user preset with your changes, Delete the current preset, or Create a new preset, if none exists with the given name. In addition to the parameter set name, you can also provide a short
2285 description for the parameter set, which will be shown in the tooltip for the
2286 parameter set's entry in the web services menu.
2287
2288 \begin{figure}[htbc]
2289 \center{
2290 \includegraphics[width=3in]{images/jvaliwsparamsbox.pdf}
2291 \caption{{\bf Jalview's JABA alignment service parameter editing dialog box}.}
2292 \label{jwsparamsdialog} }
2293 \end{figure}
2294
2295 \subsubsection{Saving Parameter Sets}
2296 When creating a custom parameter set, you will be asked for a file name to save
2297 it. The location of the file is recorded in the Jalview user preferences in the
2298 same way as a custom alignment colourscheme, so when Jalview is launched again,
2299 it will show your custom preset amongst the options available for running the
2300 JABA service.
2301
2302
2303 % \exercise{Creating and using user defined presets}{\label{createandusepreseex}
2304 % \exstep{Import the file at
2305 % \textsf{http://www.jalview.org/tutorial/fdx\_unaligned.fa} into jalview.}
2306 % \exstep{Use the `{\slDiscover Database Ids}' function to recover the PDB cross
2307 % references for the sequences.}
2308 % \exstep{Align the sequences using the default ClustalW parameters.}
2309 % \exstep{Use the `{\sl Edit and run..}'
2310 % option to open the ClustalW parameters dialog box, and create a new preset using
2311 % the following settings:
2312 % \begin{list}{$\bullet$}{}
2313 % \item BLOSUM matrix (unchanged)
2314 % \item Gap Opening and End Gap penalties = 0.05
2315 % \item Gap Extension and Separation penalties = 0.05
2316 % \end{list}
2317
2318 % As you edit the parameters, buttons will appear on the dialog box
2319 % allowing you revert your changes or save your settings as a new parameter
2320 % set.
2321
2322 % Before you save your settings, remeber to give them a meaningful name by editing
2323 % the text box at the top of the dialog box.
2324 % }
2325 % \exstep{Repeat the alignment using your new parameter set by selecting it from
2326 % the {\sl ClustalW Presets menu}.} 
2327 % \exstep{These sequences have PDB structures associated with them, so it is
2328 % possible to compare the quality of the alignments.
2329
2330 % Use the {\sl View all {\bf N}
2331 % structures} option to calculate the superposition of 1fdn on 1fxd for both
2332 % alignments (refer to section \ref{superposestructs} for instructions). Which
2333 % alignment gives the best RMSD ? }
2334 % \exstep{Apply the same alignment parameter settings to the example alignment
2335 % (available from \textsf{http://www.jalview.org/examples/uniref50.fa}). 
2336
2337 % Are there differences ? If not, why not ?
2338 % }
2339 % }
2340
2341 \section{Protein Alignment Conservation Analysis}
2342 \label{aacons}
2343 The {\sl Web Service $\Rightarrow$ Conservation} menu controls the computation
2344 of up to 17 different amino acid conservation measures for the current alignment
2345 view. The JABAWS AACon Alignment Conservation Calculation Service, which is used
2346 to calculate these scores, provides a variety of standard measures described by
2347 Valdar in 2002\footnote{Scoring residue conservation. Valdar (2002) {\sl
2348 Proteins: Structure, Function, and Genetics} {\bf 43} 227-241.} as well as an efficient implementation of the SMERFs
2349 score developed by Manning et al. in 2008.\footnote{SMERFS Score Manning et al. {\sl BMC
2350 Bioinformatics} 2008, {\bf 9} 51 \href{http://dx.doi.org/10.1186/1471-2105-9-51}{doi:10.1186/1471-2105-9-51}}
2351
2352 \subsubsection{Enabling and Disabling AACon Calculations}
2353 When the AACon Calculation entry in the {\sl Web Services $\Rightarrow$
2354 Conservation} menu is ticked, AACon calculations will be performed every time
2355 the alignment is modified. Selecting the menu item will enable or disable
2356 automatic recalculation.
2357
2358 \subsubsection{Configuring which AACon Calculations are Performed}
2359 The {\sl Web Services $\Rightarrow$ Conservation $\Rightarrow$ Change AACon
2360 Settings ...} menu entry will open a web services parameter dialog for the
2361 currently configured AACon server. Standard presets are provided for quick and
2362 more expensive conservation calculations, and parameters are also provided to
2363 change the way that SMERFS calculations are performed.
2364 AACon settings for an alignment are saved in Jalview projects along with the
2365 latest calculation results.
2366
2367 \subsubsection{Changing the Server used for AACon Calculations}
2368 If you are working with alignments too large to analyse with the public JABAWS
2369 server, then you will most likely have already configured additional JABAWS
2370 servers. By default, Jalview will chose the first AACon service available from
2371 the list of JABAWS servers available. If available, you can switch to use
2372 another AACon service by selecting it from the {\sl Web Services $\Rightarrow$
2373 Conservation $\Rightarrow$ Switch Server} submenu.
2374
2375 \chapter{Analysis of Alignments}
2376 \label{alignanalysis}
2377 Jalview provides support for sequence analysis in two ways. A number of
2378 analytical methods are `built-in', these are accessed from the {\sl Calculate}
2379 alignment window menu. Computationally intensive analyses are run outside
2380 Jalview {\sl via} web services - these are typically accessed {\sl via} the {\sl
2381 Web Service} menu, and described in \ref{jvwebservices} and subsequent sections.
2382 In this section, we describe the built-in analysis capabilities common to both
2383 the Jalview Desktop and the JalviewLite applet.
2384  
2385 \section{PCA}
2386 This calculation creates a spatial representation of the similarities within the
2387 current selection or the whole alignment if no selection has been made. After
2388 the calculation finishes, a 3D viewer displays the each sequence as a point in
2389 3D `similarity space'. Sets of similar sequences tend to lie near each other in
2390 this space.
2391 Note: The calculation is computationally expensive, and may fail for very large
2392 sets of sequences - because the JVM has run out of memory. Memory issues, and
2393 how to overcome them, were discussed in Section \ref{memorylimits}.
2394
2395 \subsubsection{What is PCA?}
2396 Principal components analysis is a technique for examining the structure of
2397 complex data sets. The components are a set of dimensions formed from the
2398 measured values in the data set, and the principle component is the one with the
2399 greatest magnitude, or length. The sets of measurements that differ the most
2400 should lie at either end of this principle axis, and the other axes correspond
2401 to less extreme patterns of variation in the data set.
2402 In this case, the components are generated by an eigenvector decomposition of
2403 the matrix formed from the sum of pairwise substitution scores at each aligned
2404 position between each pair of sequences. The basic method is described in the
2405 1995 paper by {\sl G. Casari, C. Sander} and {\sl A. Valencia} \footnote{{\sl
2406 Nature Structural Biology} (1995) {\bf 2}, 171-8.
2407 PMID: 7749921} and implemented at the SeqSpace server at the EBI.
2408
2409 Jalview provides two different options for the PCA calculation. Protein PCAs are
2410 by default computed using BLOSUM 62 pairwise substitution scores, and nucleic
2411 acid alignment PCAs are computed using a score model based on the identity
2412 matrix that also treats Us and Ts as identical, to support analysis of both RNA
2413 and DNA alignments. The {\sl Change Parameters} menu also allows the calculation
2414 method to be toggled between SeqSpace and a variant calculation that is detailed
2415 in Jalview's built in documentation.\footnote{See
2416 \url{http://www.jalview.org/help/html/calculations/pca.html}.}
2417
2418 \subsubsection{The PCA Viewer}
2419
2420 PCA analysis can be launched from the {\sl Calculate $\Rightarrow$ Principle
2421 Component Analysis} menu option. {\bf PCA requires a selection containing at
2422 least 4 sequences}.  A window opens containing the PCA tool (Figure \ref{PCA}).
2423 Each sequence is represented by a small square, coloured by the background
2424 colour of the sequence ID label. The axes can be rotated by clicking and
2425 dragging the left mouse button and zoomed using the $\uparrow$ and $\downarrow$
2426 keys or the scroll wheel of the mouse (if available).  A tool tip appears if the
2427 cursor is placed over a sequence. Sequences can be selected by clicking on them.
2428 [CTRL]-Click can be used to select multiple sequences.
2429 \begin{figure}[hbtp]
2430 \begin{center}
2431 \includegraphics[width=2in]{images/PCA1.pdf}
2432 \includegraphics[width=3in]{images/PCA3.pdf}
2433 \caption{{\bf PCA Analysis.} }
2434 \label{PCA}
2435 \end{center}
2436 \end{figure}
2437
2438 Labels will be shown for each sequence by toggling the {\sl View $\Rightarrow$
2439 Show Labels} menu option, and the plot background colour changed {\sl via} the
2440 {\sl View $\Rightarrow$ Background Colour..} dialog box. A graphical
2441 representation of the PCA plot can be exported as an EPS or PNG image {\sl via}
2442 the {\sl File $\Rightarrow$ Save As $\Rightarrow$ \ldots } submenu.
2443
2444 \exercise{Principle Component Analysis}{ \exstep{Load the alignment at
2445 \textsf{http://www.jalview.org/examples/exampleFile.jar} and press [ESC] to clear any selections. Alternatively, select {\sl Select $\Rightarrow$ Undefine Groups} to remove all groups and colourschemes. } \exstep{Select the menu option {\sl Calculate $\Rightarrow$ Principle Component Analysis}. A new window will open. Move this window so that the tree, alignment and PCA viewer window are all visible. Try rotating the plot by clicking and dragging the mouse on the plot in the PCA window. Note that clicking on points in the plot will highlight them on the alignment and tree. }
2446 \exstep{ Click on the tree window. Careful selection of the tree partition
2447 location will divide the alignment into a number of groups, each of a different
2448 colour. Note how the colour of the sequence ID label matches both the colour of
2449 the partitioned tree and the points in the PCA plot.
2450 } }
2451
2452 \subsubsection{PCA Data Export}
2453 Although the PCA viewer supports export of the current view, the plots produced
2454 are rarely suitable for direct publication. The PCA viewer's {\sl File} menu
2455 includes a number of options for exporting the PCA matrix and transformed points
2456 as comma separated value (CSV) files. These files can be imported by tools such
2457 as {\bf R} or {\bf gnuplot} in order to graph the data.
2458
2459 \section{Trees}
2460 \label{trees}
2461 Jalview can calculate and display trees, providing interactive tree-based
2462 grouping of sequences though a tree viewer. All trees are calculated {\sl via}
2463 the {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$ \ldots} submenu.
2464 Trees can be calculated from distance matrices determined from \% identity or
2465 aggregate BLOSUM 62 score using either {\sl Average Distance} (UPGMA) or {\sl
2466 Neighbour Joining} algorithms. The input data for a tree is either the selected
2467 region or the whole alignment, excluding any hidden regions.
2468
2469 On calculating a tree, a new window opens (Figure \ref{trees1}) which contains
2470 the tree. Various display settings can be found in the tree window {\sl View}
2471 menu, including font, scaling and label display options, and the {\sl File
2472 $\Rightarrow$ Save As} submenu contains options for image and Newick file
2473 export. Newick format is a standard file format for trees which allows them to
2474 be exported to other programs.  Jalview can also read in external trees in
2475 Newick format {\sl via} the {\sl File $\Rightarrow$ Load Associated Tree} menu
2476 option. Leaf names on imported trees will be matched to the associated alignment
2477 - unmatched leaves will still be displayed, and can be highlighted using the
2478 {\sl View $\Rightarrow$ Mark Unlinked Leaves} menu option.
2479
2480
2481 \begin{figure}
2482 \begin{center}
2483 \includegraphics[width=2.5in]{images/trees1.pdf}
2484 \includegraphics[width=2.5in]{images/trees2.pdf}
2485 \includegraphics[width=1.25in]{images/trees4.pdf}
2486 \caption{{\bf Calculating Trees} Jalview provides four built in models for calculating trees. 
2487 Jalview can also load precalculated trees in Newick format (right).}
2488 \label{trees1}
2489 \end{center}
2490 \end{figure}
2491
2492
2493 Clicking on the tree brings up a cursor across the height of the tree. The
2494 sequences are automatically partitioned and coloured (Figure \ref{trees2}). To
2495 group them together, select the {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$
2496 By Tree Order $\Rightarrow$ \ldots} alignment window menu option and choose the
2497 correct tree. The sequences will then be sorted according to the leaf order
2498 currently shown in the tree view. The coloured background to the sequence IDs
2499 can be removed with {\sl Select $\Rightarrow$ Undefine Groups} from the
2500 alignment window menu. Note that tree partitioning will also remove any groups
2501 and colourschemes on a view, so create a new view ([CTRL-T]) if you wish to
2502 preserve these.
2503
2504 \begin{figure}
2505 \begin{center}
2506 \includegraphics[width=5in]{images/trees3.pdf}
2507 \caption{{\bf Interactive Trees} The tree level cutoff can be used to designate
2508 groups in Jalview.}
2509 \label{trees2}
2510 \end{center}
2511 \end{figure}
2512
2513 %\subsubsection{Multiple Views and Input Data recovery from PCA and Tree Viewers}
2514 % move to ch. 3 ?
2515 %Both PCA and Tree viewers are linked analysis windows. This means that their selection and display are linked to a particular alignment, and control and reflect the selection state for a particular view.
2516
2517 \subsubsection{Recovering input Data for a Tree or PCA Plot Calculation}
2518 \parbox[c]{5in}{
2519 The {\sl File $\Rightarrow$ Input Data } option will open a new alignment window containing the original data used to calculate the tree or PCA plot (if available). This function is useful when a tree has been created and then the alignment subsequently changed. 
2520 }
2521 \parbox[c]{1.25in}{\centerline{\includegraphics[width=1.25in]{images/pca_fmenu.pdf}
2522 }}
2523
2524 \subsubsection{Changing the associated View for a Tree or PCA Viewer}
2525 \parbox[c]{4in}{
2526 The {\sl View $\Rightarrow$ Associated Nodes With $\Rightarrow$ .. } submenu is shown when the viewer is associated with an alignment that is involved in multiple views. Selecting a different view does not affect the tree or PCA data, but will change the colouring and display of selected sequences in the display according to the colouring and selection state of the newly associated view. 
2527 } \parbox[c]{3in}{\centerline{
2528 \includegraphics[width=2.5in]{images/pca_vmenu.pdf} }}
2529
2530
2531 \exercise{Trees}{
2532 \exstep{Ensure that you have at least 1G memory available in Jalview
2533 (Either start with this link:
2534 \href{http://www.jalview.org/services/launchApp?jvm-max-heap=1G}{http://www.jalview.org/services/launchApp?jvm-max-heap=1G},
2535 or in the Development section of the Jalview web site
2536 (\href{http://www.jalview.org/development/development-builds}{http://www.jalview.org/development/development-builds})
2537 in the ``latest official build'' row in the table, go to the
2538 ``Webstart'' column, click on ``G2''.)}
2539 \exstep{Open the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$ Neighbour Joining Using BLOSUM62}. A new tree window will appear.}
2540 \exstep{Click on the tree window. A cursor will appear. Note that placing this cursor divides the tree into a number of groups by colour. Place the cursor to give about 4 groups, then select {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$ By Tree Order $\Rightarrow$ Neighbour Joining Tree using BLOSUM62 from ... }. The sequences are reordered to match the order in the tree and groups are formed implicitly.}
2541 \exstep{Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$
2542 Neighbour Joining Using \% Identity}. A new tree window will appear. The group colouring 
2543 makes it easy to see the differences between the two trees, calculated using
2544  different methods.} \exstep{Select from sequence 2 column 60 to sequence 12 column 123. Select  {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$ Neighbour Joining Using BLOSUM62}. A new tree window will appear. It can be seen that the tree contains 11 sequences. It has been coloured according to the already selected groups from the first tree and is calculated purely from the residues in the selection. 
2545 Comparing the location of individual sequences between the three trees illustrates the importance of selecting appropriate regions of the alignment for the calculation of trees. 
2546 }
2547 \exstep{Recover the {\sl Input Data} for the tree you just calculated from the {\sl File} menu. Check the {\sl Edit $\Rightarrow$ Pad Gaps } option is {\sl not} ticked, and insert one gap anywhere in the alignment. Now select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$ Neighbour Joining Using BLOSUM62}. 
2548
2549 A warning dialog box {\bf ``Sequences not aligned'' } appears because the sequences input to the tree calculation are of different lengths. }
2550
2551 \exstep{Now select {\sl Edit $\Rightarrow$ Pad Gaps } and try to perform the tree calculation again - this time a new tree should appear.
2552
2553 This demonstrates the use of the {\sl Pad Gaps } editing preference, which ensures that all sequences are the same length after editing. }
2554
2555 }
2556
2557 \subsection{Tree Based Conservation Analysis}
2558 \label{treeconsanaly}
2559
2560 Trees reflect the pattern of global sequence similarity exhibited by the
2561 alignment, or region within the alignment, that was used for their calculation.
2562 The Jalview tree viewer enables sequences to be partitioned into groups based
2563 on the tree. This is done by clicking within the tree viewer window. Once subdivided, the
2564 conservation between and within groups can be visually compared in order to
2565 better understand the pattern of similarity revealed by the tree and the
2566 variation within the clades partitioned by the grouping. The conservation based
2567 colourschemes and the group associated conservation and consensus annotation
2568 (enabled using the alignment window's {\sl View $\Rightarrow$ Autocalculated
2569 Annotation $\Rightarrow$ Group Conservation} and {\sl Group Consensus} options)
2570 can help when working with larger alignments.
2571
2572 \exercise{Tree Based Conservation Analysis}{
2573 \label{consanalyexerc}
2574 \exstep{Load the PF03460 PFAM seed alignment using the sequence fetcher. Colour it with the {\sl Taylor colourscheme}, and apply {\sl Conservation } shading. }
2575 \exstep{Build a Neighbour joining tree using BLOSUM62 and use the {\sl Sort
2576 Alignment By Tree} option in the tree viewer submenu to order alignment using the calculated tree.} \exstep{Select a point on the tree to partition the alignment, and examine the variation in colouring between different groups. 
2577
2578 You may find it easier to browse the alignment if you first uncheck the {\sl
2579 Annotations $\Rightarrow$ Show Annotations} option, and open the Overview Window
2580 within the View menu to aid navigation.}
2581 \exstep{Try changing the colourscheme to BLOSUM62 (whilst ensuring that {\sl Apply Colour to All Groups} is selected)}
2582 {\sl Note: You may want to save the alignment and tree as a project file, since
2583 it is used in the next few exercises. } }
2584
2585 \subsection{Redundancy Removal}
2586
2587 The redundancy removal dialog box is opened using the {\sl Edit $\Rightarrow$ Remove Redundancy\ldots} option in the alignment menu. As its menu option placement suggests, this is actually an alignment editing function, but it is convenient to describe it here. The redundancy removal dialog box presents a percentage identity slider which sets the redundancy threshold. Aligned sequences which exhibit a percentage identity greater than the current threshold are highlighted in black. The [Remove] button can then be used to delete these sequences from the alignment as an edit operation\footnote{Which can usually be undone. A future version of Jalview may allow redundant sequences to be hidden, or represented by a chosen sequence, rather than deleted.}.
2588 \begin{figure}
2589 \begin{center}
2590 \includegraphics[width=5.5in]{images/redundancy.pdf}
2591 \end{center}
2592 \label{removeredundancydialog}
2593 \caption{The Redundancy Removal dialog box opened from the edit menu. Sequences that exceed the current percentage identity threshold and are to be removed are highlighted in black.}
2594 \end{figure}
2595
2596 \exercise{Remove Redundant Sequences}{
2597
2598 \exstep{Re-use or recreate the alignment and tree which you worked with in the
2599 tree based conservation analysis exercise (exercise \ref{consanalyexerc}). In
2600 the alignment window, you may need to deselect groups using Esc key.}
2601 \exstep{In the Edit menu select Remove Redundancy to open the Redundancy
2602 threshold selection dialog. Adjust the redundancy threshold value, start
2603 at 50 and increase the value to 65. Sequences selected will change colour in the Sequence ID panel. Select ``Remove'' to
2604 remove the sequences that are more than 65\% similar under this alignment.}
2605 \exstep{Select the Tree viewer's {\sl View $\Rightarrow$ Mark Unlinked Leaves} option, and note that the removed sequences are now prefixed with a * in the tree view.}
2606 \exstep{Use the [Undo] button in the Redundancy threshold selection dialog box
2607 to recover the sequences. Note that the * symbols disappear from the tree display.}
2608 \exstep{Experiment with the redundancy removal and observe the relationship between the percentage identity threshold and the pattern of unlinked nodes in the tree display.}
2609 }
2610
2611 \subsection{Subdividing the Alignment According to Specific Mutations}
2612
2613 It is often necessary to explore variations in an alignment that may correlate
2614 with mutations observed in a particular region; for example, sites exhibiting
2615 single nucleotide polymorphism, or residues involved in substrate recognition in
2616 an enzyme. One way to do this would be to calculate a tree using the specific
2617 region, and subdivide it in order to partition the alignment.
2618 However, calculating a tree can be slow for large alignments, and the tree may
2619 be difficult to partition when complex mutation patterns are being analysed. The
2620 {\sl Select $\Rightarrow$ Make groups for selection } function was introduced to
2621 make this kind of analysis easier. When selected, it will use the characters in
2622 the currently selected region to subdivide the alignment. For example, if a
2623 single column is selected, then the alignment (or each group defined on the
2624 alignment) will be divided into groups based on the residue or nucleotide found
2625 at that position. These new groups are annotated with the characters in the
2626 selected region, and Jalview's group based conservation analysis annotation and
2627 colourschemes can then be used to reveal any associated pattern of sequence
2628 variation across the whole alignment.
2629
2630 \subsection{Automated Annotation of Alignments and Groups}
2631
2632 On loading a sequence alignment, Jalview will normally\footnote{Automatic
2633 annotation can be turned off in the {\sl Visual } tab in the {\sl Tools
2634 $\Rightarrow$ Preferences } dialog box.} calculate a set of automatic annotation
2635 rows which are shown below the alignment. For nucleotide sequence alignments,
2636 only an alignment consensus row will be shown, but for amino acid sequences,
2637 alignment quality (based on BLOSUM 62) and physicochemical conservation will
2638 also be shown. Conservation is calculated according to Livingstone and
2639 Barton\footnote{{\sl ``Protein Sequence Alignments: A Strategy for the
2640 Hierarchical Analysis of Residue Conservation." } Livingstone C.D. and Barton
2641 G.J. (1993) {\sl CABIOS } {\bf 9}, 745-756}.
2642 Consensus is the modal residue (or {\tt +} where there is an equal top residue).
2643 The inclusion of gaps in the consensus calculation can be toggled by
2644 right-clicking on the the Consensus label and selecting {\sl Ignore Gaps in
2645 Consensus} from the pop-up context menu located with consensus annotation row.
2646 Quality is a measure of the inverse likelihood of unfavourable mutations in the alignment. Further details on these
2647 calculations can be found in the on-line documentation.
2648
2649 These annotations can be hidden and deleted via the context menu linked to the
2650 annotation row; but they are only created on loading an alignment. If they are
2651 deleted then the alignment should be saved and then reloaded to restore them.
2652 Jalview provides a toggle to autocalculate a consensus sequence upon editing. This is normally selected by default, but can be turned off for
2653 large alignments {\sl via} the {\sl Calculate $\Rightarrow$ Autocalculate
2654 Consensus} menu option if the interface is too slow.
2655
2656 \subsubsection{Group Associated Annotation}
2657 \label{groupassocannotation}
2658 Group associated consensus and conservation annotation rows reflect the
2659 sequence variation within a particular group. Their calculation is enabled
2660 by selecting the {\sl Group Conservation} or {\sl Group Consensus} options in
2661 the {\sl Annotation $\Rightarrow$ Autocalculated Annotation } submenu of the
2662 alignment window. 
2663
2664 \subsubsection{Alignment and Group Sequence Logos}
2665 \label{seqlogos}
2666
2667 The consensus annotation row that is shown below the alignment can be overlaid
2668 with a sequence logo that reflects the symbol distribution at each column of
2669 the alignment. Right click on the Consensus annotation row and select the {\sl Show
2670 Logo} option to display the Consensus profile for the group or alignment.
2671 Sequence logos can be enabled by default for all new alignments {\sl via} the
2672 Visual tab in the Jalview desktop's preferences dialog box.
2673
2674 \exercise{Group Conservation Analysis}{
2675 \exstep{Re-use or recreate the alignment and tree which you worked with in the
2676 tree based conservation analysis exercise (exercise \ref{consanalyexerc})} 
2677 \exstep{In the View menu, create a new view. Ensure the annotation panel
2678 is displayed (Show annotation in Annotations menu). Enable the display
2679 of {\sl Group Consensus} option by checking {\sl Group Consensus} in the {\sl Annotation $\Rightarrow$
2680 Autocalculated Annotation } submenu in the sequence alignment window. Then display of sequence 
2681 logos to make it easier to see the different residue populations within each
2682 group. Activate logo by right clicking on the Consensus annotation row to open
2683 the pop-up menu and select the {\sl Show Logo} option.} 
2684 \exstep{In the column alignment ruler, select a column exhibiting about 50\%
2685 conservation that lies within the central conserved region of the alignment. Subdivide the alignment according to
2686 this selection using {\sl Select $\Rightarrow$ Make groups for selection}.}
2687 \exstep{Re-order the alignment according to the new groups that have been
2688 defined. Click on the group annotation row IDs to select groups exhibiting a
2689 specific mutation.}
2690 \exstep{Select another column exhibiting about 50\% conservation
2691 overall, and subdivide the alignment further. Note that the new groups
2692 inherit the names of the original groups, allowing you to identify the
2693 combination of mutations that resulted in the subdivision.
2694 }
2695 \exstep{Clear the groups, and try to subdivide the alignment using two
2696 non-adjacent columns.
2697
2698 {\sl Hint: You may need to hide the intervening columns before you can select
2699 both of the columns that you wish to use to subdivide the alignment.}}
2700 \exstep{Switch back to the original view, and experiment with subdividing
2701 the tree groups made in the previous exercise.}
2702 }
2703
2704 \subsection{Other Calculations}
2705
2706
2707 \subsubsection{Pairwise Alignments}
2708
2709 Jalview can calculate optimal pairwise alignments between arbitrary sequences {\sl via} the {\sl Calculate $\Rightarrow$ Pairwise Alignments\ldots} menu option. Global alignments of all pairwise combinations of the selected sequences are performed and the results returned in a text box.
2710
2711 \begin{figure}[]
2712 \begin{center}
2713 \includegraphics[width=4in]{images/pairwise.pdf}
2714 \caption{{\bf Pairwise alignment of sequences.} Pairwise alignments of three selected sequences are shown in a textbox.}
2715 \label{pairwise}
2716 \end{center}
2717 \end{figure}
2718
2719 \pagebreak[2]
2720
2721 \chapter{Working with 3D structures}
2722 \label{3Dstructure}
2723
2724
2725 This chapter describes the annotation, analysis, and visualization tasks that
2726 the Jalview Desktop can perform.
2727
2728 Section \ref{wkwithstructure} introduces the structure visualization
2729 capabilities of Jalview. In Section \ref{alignanalysis}, you will find
2730 descriptions and exercises on building and displaying trees, PCA analysis,
2731 alignment redundancy removal, pairwise alignments and alignment conservation
2732 analysis. Section \ref{jvwebservices} introduces the various web based services
2733 available to Jalview users, and Section \ref{jabaservices} explains how to
2734 configure the Jalview Desktop for access to new JABAWS servers.
2735 Section \ref{msaservices} describes how to use the range of multiple alignment
2736 programs provided by JABAWS, and Section \ref{aacons} introduces JABAWS AACon
2737 service for protein multiple alignment conservation analysis.
2738 Section \ref{protsspredservices} explains how to perform protein secondary
2739 structure predictions with JPred, and JABAWS protein disorder prediction
2740 services are introduced in Section \ref{protdisorderpred}.
2741
2742 Section \ref{featannot} describes the mechanisms provided by Jalview for
2743 interactive creation of sequence and alignment annotation, and how they can be
2744 displayed, imported and exported and used to reorder the alignment. Section
2745 \ref{featuresfromdb} discusses the retrieval of database references and
2746 establishment of sequence coordinate systems for the retrieval and display of
2747 features from databases and DAS annotation services. Section
2748 \ref{workingwithnuc} describes functions and visualization techniques relevant
2749 to working with nucleotide sequences, coding region annotation and nucleotide
2750 sequence alignments.
2751 % and Section \ref{workingwithrna} covers the visualization,
2752 % editing and analysis of RNA secondary structure.
2753
2754 \section{Working with Structures}
2755 \label{wkwithstructure}
2756 Jalview facilitates the use of protein structures for the analysis of alignments
2757 by providing a linked view of structures associated with sequences in
2758 the alignment. The Java based molecular viewing program Jmol\footnote{See the
2759 Jmol homepage \url{http://www.jmol.org} for more information.} has been
2760 incorporated\footnote{Earlier versions of Jalview included MCView - a simple
2761 main chain structure viewer. Structures are visualized as an alpha carbon trace
2762 and can be viewed, rotated and coloured in a structure viewer and the results
2763 interpreted on a sequence alignment.} which enables sophisticated molecular
2764 visualizations to be prepared and investigated alongside an analysis of
2765 associated sequences.
2766 PDB format files can be imported directly or structures can be retrieved from
2767 the European Protein Databank (PDBe) using the Sequence Fetcher (see
2768 \ref{fetchseq}).
2769
2770 \subsection{Automatic Association of PDB Structures with Sequences}
2771 Jalview can automatically determine which structures are associated with a
2772 sequence in a number of ways.
2773 \subsubsection{Discovery of PDB IDs from Sequence Database Cross-references}
2774 If a sequence has an ID from a public database that contains cross-references to
2775 the PDB, such as Uniprot. Right-click on any sequence ID and select {\sl Structure $\Rightarrow$
2776 Associate Structure with Sequence $\Rightarrow$ Discover PDB IDs } from the context menu (Figure \ref{auto}). Jalview will attempt to associate the
2777 sequence with a Uniprot sequence and from there discover any associated PDB
2778 structures. This takes a few seconds and applies to all sequences in the
2779 alignment which have valid Uniprot IDs. On moving the cursor over the sequence
2780 ID the tool tip\footnote{Tip: The sequence ID tooltip can often become large for
2781 heavily cross referenced sequence IDs. Use the {\sl View $\Rightarrow$ Sequence
2782 ID Tooltip $\Rightarrow$ } submenu to disable the display of database cross
2783 references or non-positional features. } now shows the Uniprot ID and any
2784 associated PDB structures.
2785
2786 \begin{figure}[htbp]
2787 \begin{center}
2788 %TODO fix formatting
2789 \parbox{1.5in}{
2790 {\centering 
2791 \begin{center}
2792 \includegraphics[width=1.5in]{images/auto1.pdf}
2793 \end{center}}
2794 } \parbox{3.25in}{
2795 {\centering 
2796 \begin{center}
2797 \includegraphics[scale=0.5]{images/auto2.pdf}
2798 \end{center}
2799 }
2800 } \parbox{1.5in}{
2801 {\centering 
2802 \begin{center} 
2803 \includegraphics[width=1.5in]{images/auto3.pdf}
2804 \end{center}
2805 }
2806 }
2807
2808 \caption{{\bf Automatic PDB ID discovery.} The tooltip (left) indicates that no PDB structure has been associated with the sequence. 
2809 After PDB ID discovery (center) the tool tip now indicates the Uniprot ID and
2810 any associated PDB structures (right).}
2811 \label{auto}
2812 \end{center}
2813 \end{figure}
2814
2815 \subsubsection{Drag-and-Drop Association of PDB Files with Sequences by Filename
2816 Match}
2817 \label{multipdbfileassoc}
2818 If one or more PDB files stored on your computer are dragged from their location
2819 on the file browser onto an alignment window, Jalview will search the alignment
2820 for sequences with IDs that match any of the files dropped onto the alignment.
2821 If it discovers matches, a dialog like the one in Figure
2822 \ref{multipdbfileassocfig} is shown, giving the option of creating associations
2823 for the matches.
2824
2825 If no associations are made, then sequences extracted
2826 from the structure will be simply added to the alignment. However, if only
2827 some of the PDB files are associated, Jalview will raise another dialog box
2828 giving you the option to add any remaining sequences from the PDB structure files not present in
2829 the alignment. This allows you to easily decorate sequences in a newly imported
2830 alignment with any corresponding structures you've already collected in a directory
2831 accessible from your computer.\footnote{We plan to extend this facility in
2832 future so Jalview will automatically search for PDB files matching your
2833 sequence within a local directory. Check out 
2834 \href{http://issues.jalview.org/browse/JAL-801}{Jalview issue 801}}
2835
2836 % there is no mention of the other footnote (#3) that appears saying: Tip: The sequence ID tooltip can often become large for heavily cross-referenced sequence IDs. Use the ...
2837 % JBP: yes there is - under 'Discovery of ' subsection.
2838 \begin{figure}[htbp]
2839 \begin{center}
2840 \includegraphics[]{images/pdbdragdropassoc.pdf}
2841
2842 \caption{{\bf Associating PDB files with sequences by drag-and-drop.} Dragging
2843 PDB files onto an alignment of sequences with names matching the dragged files
2844 names (A), results in a dialog box (B) that gives the option to associate each
2845 file with any sequences with matching IDs. }
2846 \label{multipdbfileassocfig}
2847 \end{center}
2848 \end{figure}
2849
2850
2851 \subsection{Viewing Structures}
2852 \label{viewAllStructures}
2853 The structure viewer can be launched in two ways from the sequence ID context
2854 menu. To view a particular structure associated with a sequence in the
2855 alignment, simply select it from popup menu's associated structures submenu in
2856 {\sl Structure $\Rightarrow$ View Structure $\Rightarrow$ $<$PDB ID$>$}. The
2857 second way is most useful if you want to view all structural data available for
2858 a set of sequences in an alignment. If any of the {\bf currently selected}
2859 sequences have structures associated, the {\sl Structure } submenu of the
2860 sequence ID popup menu will include an option to {\sl View {\bf N}
2861 structures}. Selecting this option will open a new structure view containing
2862 the associated structures superposed according to the alignment.
2863
2864 In both cases, each structure to be displayed will be downloaded or loaded from
2865 the local file system, and shown as a ribbon diagram coloured according to the
2866 associated sequence in the current alignment view (Figure \ref{structure}
2867 (right)). The structure can be rotated by clicking and dragging in the structure
2868 window. The structure can be zoomed using the mouse scroll wheel or by
2869 [SHIFT]-dragging the structure.
2870 Moving the mouse cursor over a sequence to which the structure is linked in the
2871 alignment view highlights the respective residue's sidechain atoms. The
2872 sidechain highlight may be obscured by other parts of the molecule. Similarly,
2873 moving the cursor over the structure shows a tooltip and highlights the
2874 corresponding residue in the alignment. Clicking the alpha carbon or phosphorous
2875 backbone atom will toggle the highlight and residue label on and off. Often, the
2876 position highlighted in the sequence may not be in the visible portion of the
2877 current alignment view and the sliders will scroll automatically to show the
2878 position. If the alignment window's {\sl View $\Rightarrow$ Automatic Scrolling
2879 } option is not selected, however, then the automatic adjustment will be
2880 disabled for the current view.
2881
2882 \begin{figure}[htbp]
2883 \begin{center}
2884 \parbox{3in}{
2885 {\centering 
2886 \begin{center}
2887 \includegraphics[scale=0.5]{images/structure1.pdf}
2888 \end{center}
2889 }
2890 }
2891 \parbox{3.2in}{
2892 {\centering 
2893 \begin{center}
2894 \includegraphics[width=3in]{images/structure2.pdf}
2895 \end{center}
2896 }
2897 }
2898 \caption{{\bf Structure visualization} The structure viewer is launched from the sequence ID context menu (left) and allows the structure to be visualized using the embedded Jmol molecular viewer (right). }
2899 \label{structure}
2900 \end{center}
2901 \end{figure}
2902
2903 \subsection{Customising Structure Display}
2904
2905 Structure display can be modified using the {\sl Colour} and {\sl View} menus
2906 in the structure viewer. The background colour can be modified by selecting the
2907 {\sl Colours $\Rightarrow$ Background Colour\ldots} option.
2908
2909 By default, the structure will be coloured in the same way as the associated
2910 sequence(s) in the alignment view from which it was launched. The structure can
2911 be coloured independently of the sequence by selecting an appropriate colour
2912 scheme from the {\sl Colours} menu. It can be coloured according to the
2913 alignment using the {\sl Colours $\Rightarrow$ By Sequence } option. The image
2914 in the structure viewer can be saved as an EPS or PNG with the {\sl File
2915 $\Rightarrow$ Save As $\Rightarrow$ \ldots} submenu, which also allows the raw
2916 data to be saved as PDB format. The mapping between the structure and the
2917 sequence (How well and which parts of the structure relate to the sequence) can
2918 be viewed with the {\sl File $\Rightarrow$ View Mapping} menu option.
2919
2920 \subsubsection{Using the Jmol Visualization Interface }
2921
2922 Jmol has a comprehensive set of selection and visualization functions that are
2923 accessed from the Jmol popup menu (by right-clicking in the Jmol window or by
2924 clicking the Jmol logo). Molecule colour and rendering style can be manipulated,
2925 and distance measurements and molecular surfaces can be added to the view. It
2926 also has its own ``Rasmol\footnote{See \url{http://www.rasmol.org}}-like'' scripting
2927 language, which is described elsewhere\footnote{Jmol Wiki:
2928 \url{http://wiki.jmol.org/index.php/Scripting}
2929
2930 Jmol Scripting reference:
2931 \url{http://www.stolaf.edu/academics/chemapps/jmol/docs/}}. Jalview utilises the
2932 scripting language to interact with Jmol and to store the state of a Jmol
2933 visualization within Jalview archives, in addition to the PDB data file
2934 originally loaded or retrieved by Jalview. To access the Jmol scripting
2935 environment directly, use the {\sl Jmol $\Rightarrow$ Console} menu option.
2936
2937 If you would prefer to use Jmol to manage structure colours, then select the
2938 {\sl Colours $\Rightarrow$ Colour with Jmol} option. This will disable any
2939 automatic application of colour schemes when new structure data is added, or
2940 when associated alignment views are modified.
2941
2942
2943 \exercise{Viewing Structures}{\label{viewingstructex}
2944 \exstep{Load the alignment at
2945 \textsf{http://www.jalview.org/examples/exampleFile.jar}. Right-click on the
2946 sequence ID label of {\sl FER1\_SPIOL}, this brings up
2947 the context menu. Select {\sl FER1\_SPIOL $\Rightarrow$ Structure $\Rightarrow$
2948 Associate Structure with Sequence $\Rightarrow$ Discover
2949 PDB IDs}. Jalview will now attempt to find PDB structures for the sequences in
2950 the alignment. 
2951 % JBP Note: Bug JAL-1238 needs to be fixed ASAP
2952
2953 {\bf Note:} If you are using Jalview v2.8 - use the {\sl Uniprot } source from the {\sl Web services $\Rightarrow$ Fetch DB References $\Rightarrow$ ..} submenu of the Alignment Window to retrieve the PDB IDs. }
2954 \exstep{ Right-click on the sequence ID for {\sl FER1\_SPIOL}.
2955 Select { \sl FER1\_SPIOL $\Rightarrow$ Structure $\Rightarrow$ View Structure
2956 $\Rightarrow$ 1A70}. A structure viewing window appears. Rotate the molecule by clicking and dragging in the structure viewing box. Zoom with the mouse scroll wheel. } \exstep{Roll the mouse cursor along the {\sl FER1\_SPIOL} sequence in the alignment. Note that if a residue in the sequence maps to one in the structure, a label will appear next to that residue in the structure viewer. Move the mouse over the structure. Placing the mouse over a part of the structure will bring up a tool tip indicating the name and number of that residue. The corresponding residue in the sequence is highlighted in black. Clicking the alpha carbon toggles the highlight and residue label on and off. Try this by clicking on a set of three or four adjacent residues so that the labels are persistent, then finding where they are in the sequence. }
2957 \exstep{Select {\sl Colours $\Rightarrow$ Background Colour\ldots} from the structure viewer menu and choose a suitable colour. Press OK to apply this. Select {\sl File $\Rightarrow$ Save As $\Rightarrow$ PNG} and save the image. View this with a suitable program. }
2958 \exstep{Select {\sl File $\Rightarrow$ View Mapping} from the structure viewer menu. A new window opens showing the residue by residue alignment between the sequence and the structure.} 
2959 \exstep{Select {\sl File $\Rightarrow$ Save $\Rightarrow$ PDB file} and choose a new filename to save the PDB file. Once the file is saved, open the location in your file browser (or explorer window) and drag the PDB file that you just saved on to the Jalview desktop (or load it from the {\sl Jalview Desktop $\Rightarrow$ Input Alignment $\Rightarrow$ From File } menu). Verify that you can open and view the associated structure from the sequence ID pop-up menu's {\sl Structure } submenu in the new alignment window.}
2960
2961 \exstep{Right click on the structure in the submenu and bring up the Jmol
2962 window.
2963 Explore the menu options. Try to change the style of molecular display - by first using the {\sl Jmol $\Rightarrow$ Select (n) $\Rightarrow$ All} command (where {\sl n} is the number of residues selected), and then the {\sl Jmol $\Rightarrow$ Style $\Rightarrow$ Scheme $\Rightarrow$ Ball and Stick} command.} \exstep{Use the {\sl File $\Rightarrow$ Save As .. } function to save the alignment as a Jalview Project. Now close the alignment and the structure view, and load the project file you just saved.
2964
2965 Verify that the Jmol display is as it was when you just saved the file.}
2966 }
2967
2968 \subsection{Superimposing Structures}
2969 \label{superposestructs}
2970 Many comparative biomolecular analysis investigations aim to determine if the
2971 biochemical properties of a given molecule are significantly different to its
2972 homologues. When structure data is available, comparing the shapes of molecules
2973 by superimposing them enables substructure that may impart different behaviour
2974 to be quickly identified. The identification of optimal 3D superpositions
2975 involves aligning 3D data rather than sequence symbols, but the result can
2976 still be represented as a sequence alignment, where columns indicate positions
2977 in each molecule that should be superposed to recreate the optimal 3D alignment.
2978
2979 Jalview can employ Jmol's 3D fitting routines\footnote{See
2980 \href{http://chemapps.stolaf.edu/jmol/docs/?ver=12.2$\#$compare}{http://chemapps.stolaf.edu/jmol/docs/?ver=12.2$\#$compare}
2981 for more information.} to recreate 3D structure superpositions based on the
2982 correspondences defined by one or more sequence alignments involving structures shown in the Jmol display. Superposition based on the currently displayed alignment view happens automatically if a
2983 structure is added to an existing Jmol display using the {\sl Structure
2984 $\Rightarrow$ View PDB Structure $\Rightarrow$ ..}. A new Jmol view containing
2985 superposed structures can also be created using the {\sl Structure
2986 $\Rightarrow$ View all {\bf N} PDB Structures} option (when {\bf {\sl N}}
2987 $>$ 1) if the current selection contains two or more sequences with associated
2988 structures.
2989
2990 \subsubsection{Obtaining the RMSD for a Superposition}
2991 The RMSD (Root Mean Square Deviation) is a measure of how similar the structures
2992 are when they are superimposed. Figure \ref{mstrucsuperposition} shows a
2993 superposition created during the course of Exercise \ref{superpositionex}. The
2994 parts of each molecule used to construct the superposition are rendered using
2995 the cartoon style, with other parts of the molecule drawn in wireframe. The Jmol
2996 console, which has been opened after the superposition was performed, shows the
2997 RMSD report for the superposition.
2998 Full information about the superposition is also outputed to the Jalview
2999 console.\footnote{The Jalview Java Console is opened from {\sl Tools
3000 $\Rightarrow$ Java Console} option in the Desktop's menu bar} This output also
3001 includes the precise atom pairs used to superpose structures.
3002
3003 \subsubsection{Choosing which part of the Alignment is used for Structural
3004 Superposition} Jalview uses the visible part of each alignment view to define
3005 which parts of each molecule are to be superimposed. Hiding a column in a view
3006 used for superposition will remove that correspondence from the set, and will
3007 exclude it from the superposition and RMSD calculation.
3008 This allows the selection of specific parts of the alignment to be used for
3009 superposition. Only columns that define a complete set of correspondences for
3010 all structures will be used for structural superposition, and as a consequence,
3011 the RMSD values generated for each pair of structures superimposed can be
3012 directly compared.
3013
3014 In order to recompute a superposition after changing a view or editing the
3015 alignment, select the {\sl Jmol $\Rightarrow$ Align sequences } menu option. The {\sl
3016 Jmol $\Rightarrow$ Superpose with ..} submenu allows you to choose which of the
3017 associated alignments and views are to be used to create the set of
3018 correspondences. This menu is useful when composing complex superpositions
3019 involving multi-domain and multi-chain complexes, when correspondences may be
3020 defined by more than one alignment.
3021
3022 Note that these menu options appear when you have two or more structures in one Jmol viewer.
3023
3024
3025
3026 \begin{figure}[htbp]
3027 \begin{center}
3028 \includegraphics[width=5.5in]{images/fdxsuperposition.pdf}
3029 \caption{{\bf Superposition of two ferredoxin structures.} The alignment on the
3030 left was used by Jalview to superpose structures associated with the
3031 FER1\_SPIOL and FER1\_MAIZE sequences in the alignment. Parts of each structure
3032 used for superposition are rendered as a cartoon, the remainder rendered in
3033 wireframe. The RMSD between corresponding positions in the structures before and
3034 after the superposition is shown in the Jmol console.}
3035 \label{mstrucsuperposition}
3036 \end{center}
3037 \end{figure}
3038
3039 \exercise{Aligning Structures using the Ferredoxin
3040 Sequence Alignment}{\label{superpositionex}
3041
3042 \exstep{Continue with the Jalview project created in exercise
3043 \ref{viewingstructex}. Use the {\sl Discover PDB IDs} function to retrieve PDB
3044 IDs associated with the FER1\_MAIZE sequence.}
3045 \exstep{Once discovery has completed, use the {\sl
3046 View PDB Structure} submenu to view one of the PDB file associated with
3047 FER1\_MAIZE (eg. 3B2F)
3048 Jalview will give you the option of aligning the structure to the one already
3049 open. To superimpose the structure associated with FER1\_MAIZE with the one
3050 associated with FER1\_SPIOL, press the {\bf Yes} button.
3051
3052 {\sl The Jmol view will update to show both structures, and one will be
3053 moved on to the other. If this doesn't happen, use the Align function in the Jmol submenu}}
3054 \exstep{Create a new view on the alignment, and hide all but columns 121
3055 through to 132.}
3056 \exstep{Use the {\sl Jmol} submenu to
3057 recompute the superposition using just columns 121-132 of the alignment
3058 (The easiest way to achieve this is to select column 121-132 and in the View
3059 menu selected ``All but selected region'' from the Hide options).
3060
3061 {\sl Note how the molecules shift position when superposed using a short part of
3062 the two structures.}}
3063 \exstep{Compare the initial and final RMSDs for superimposing molecules with
3064 the small section and with the whole alignment. (The RMSD report can be
3065 viewed by right clicking the mouse on Jmol window, and select ``Show" and ``Measurements") Which view do you think give the best 3D
3066 superposition, and why ?} }
3067
3068 \subsection{Colouring Structure Data Associated with Multiple Alignments and
3069 Views} Normally, the original view from which a particular structure view was
3070 opened will be the one used to colour structure data. If alignments involving
3071 sequences associated with structure data shown in a Jmol have multiple views, Jalview gives you full control
3072 over which alignment, or alignment view, is used to colour the structure
3073 display. Sequence-structure colouring associations are
3074 changed {\sl via} the {\sl View $\Rightarrow$ Colour by ..} menu, which lists all
3075 views associated with data shown in the embedded Jmol view. A tick is shown beside
3076 views currently used as colouring source, and moving the
3077 mouse over each view will bring it to the front of the alignment display,
3078 allowing you to browse available colour sources prior to selecting one. If the
3079 {\sl Select many views} option is selected, then multiple views can be selected as sources for colouring the
3080 structure data. {\sl Invert selection} and {\sl Select all views} options are also provided to quickly change between multi-view selections.
3081
3082 Note that the {\sl Select many views} option is useful if you have different
3083 views that colour different areas or domains of the alignment. This option is
3084 further explored in Section \ref{complexstructurecolours}.
3085
3086 \begin{figure}[htbp]
3087 \begin{center}
3088 \includegraphics[width=5.5in]{images/mviewstructurecol.pdf}
3089 \caption{{\bf Choosing a different view for colouring a structure display}
3090 Browsing the {\sl View $\Rightarrow$ Colour by ..} menu provides full control
3091 of which alignment view is used to colour structures when the {\sl Colours
3092 $\Rightarrow$ By Sequence} option is selected.}
3093 \label{mviewstructurecol}
3094 \end{center}
3095 \end{figure}
3096
3097 \subsubsection{Colouring Complexes}
3098 \label{complexstructurecolours}
3099 The ability to control which multiple alignment view is used to colour
3100 structural data is essential when working with data relating to
3101 multidomain biomolecules and complexes. 
3102
3103 In these situations, each chain identified in the structure may have a different
3104 evolutionary history, and a complete picture of functional variation can
3105 only be gained by integrating data from different alignments on the same
3106 structure view. An example of this is shown in Figure
3107 \ref{mviewalcomplex}, based on data from Song et. al.\footnote{Structure of
3108 DNMT1-DNA Complex Reveals a Role for Autoinhibition in Maintenance DNA Methylation. Jikui Song, Olga Rechkoblit, Timothy H. Bestor, and Dinshaw J. Patel.
3109 {\sl Science} 2011 {\bf 331} 1036-1040
3110 \href{http://www.sciencemag.org/content/331/6020/1036}{DOI:10.1126/science.1195380}}
3111
3112 \begin{figure}[htbp]
3113 \begin{center}
3114 \includegraphics[]{images/mchainstructureview.pdf}
3115 \caption{{\bf The biological assembly of Mouse DNA Methyltransferase-1 coloured
3116 by Pfam alignments for its major domains} Alignments for each domain within the
3117 Uniprot sequence DNMT1\_MOUSE have been used to visualise sequence conservation
3118 in each component of this protein-DNA complex. Instructions for recreating this figure are given in exercise \ref{dnmtcomplexex}. }
3119 \label{mviewalcomplex}
3120 \end{center}
3121 \end{figure}
3122
3123 \exercise{Colouring a Protein Complex to Explore Domain-Domain
3124 Interfaces}{\label{dnmtcomplexex}
3125
3126 \exstep{Download the PDB file at
3127 \textsf{\url{http://www.jalview.org/tutorial/DNMT1\_MOUSE.pdb}} to your desktop. 
3128
3129 This is the biological unit for PDB ID 3pt6, as identified by the PDBe's PISA
3130 server.}
3131
3132 \exstep{Launch the Jalview desktop and ensure you have at least 256MB of
3133 free memory available.
3134
3135 {\sl Use the following webstart link:
3136
3137 \href{http://www.jalview.org/services/launchApp?jvm-max-heap=1G}{http://www.jalview.org/services/launchApp?jvm-max-heap=1G}.}
3138
3139 {\sl Alternatively in the Development section of the Jalview web site
3140 (\href{http://www.jalview.org/development/development-builds}{http://www.jalview.org/development/development-builds})
3141 in the ``latest official build'' row in the table, go to the
3142 ``Webstart'' column, click on ``G2''.}}
3143 \exstep{Retrieve the following {\bf full} PFAM alignments: PF02008, PF01426
3144 (make sure you select the {\sl PFAM {\bf (Full)}} source). These will each be retrieved into their own alignment window.} \exstep{Drag the URL or file of the structure you downloaded in
3145 step 1 onto one of the alignments to associate it with the mouse sequence in
3146 that Pfam domain family.}
3147 \exstep{For every DNMT1\_MOUSE sequence in the alignment, use the sequence
3148 ID popup menu's {\sl Structure} submenu to view the DNMT1\_MOUSE structure for the associated mouse sequence. When given the option, {\bf view all of the structures in the same Jmol viewer}. Check the contents of the {\sl View $\Rightarrow$ Colour by ..} submenu to see what alignments can be used to
3149 colour the sequence.}
3150 \exstep{Repeat the previous two steps for each of
3151 the other alignments. In each case, when performing the `View DNMT1\_MOUSE.pdb'
3152 step, Jalview will ask if you wish to create a new Jmol view. You should
3153 respond `No', {\bf ensuring that each sequence fragment is associated with the same Jmol view}.}
3154 \exstep{Pick a different colourscheme for each alignment, and use the {\sl
3155 Colour by ..} submenu to ensure they are all used to colour the complex shown
3156 in the Jmol window.}
3157 \exstep{The final step needed to reproduce the shading in Figure
3158 \ref{mviewalcomplex} is to use the {\sl Colour $\Rightarrow$ By
3159 Annotation } option in each alignment window to shade the alignment by the
3160 {\bf Conservation} annotation row. This function was described in section
3161 \ref{colourbyannotation}. 
3162
3163 Ensure that you first disable the {\sl View $\Rightarrow$ Show Features} menu option, or you may not see any colour changes in the associated structure.
3164
3165 {\sl Note: Choose a different shading scheme for each
3166 alignment so that the regions of strong physicochemical conservation are highlighted. This
3167 kind of shading will reveal conserved regions of interaction between domains 
3168 in the structure.}}
3169 \exstep{Save your work as a Jalview project and verify that it can be opened again by starting another Jalview Desktop instance, and dragging the saved project into the desktop window.}
3170
3171 % {\sl Note: This exercise relies on new features introduced in Jalview 2.7. If
3172 % you notice any strange behaviour when trying out this exercise, it may be a
3173 % bug (see
3174 % \href{http://issues.jalview.org/browse/JAL-1008}{http://issues.jalview.org/browse/JAL-1008}
3175 % for one relating to highlighting of positions in the alignment window).}
3176 }
3177
3178 % TODO
3179 \chapter{Protein Prediction Analysis}
3180 \label{proteinprediction}
3181 \section{Protein Secondary Structure Prediction}
3182 \label{protsspredservices}
3183 Protein secondary structure prediction is performed using the
3184 Jpred\footnote{{\sl ``The Jpred 3 Secondary Structure Prediction Server''} Cole, C., Barber, J. D. and Barton, G. J. (2008) {\sl Nucleic Acids Research} {\bf 36}, (Web Server Issue) W197-W201
3185
3186 {\sl ``Jpred: A Consensus Secondary Structure Prediction Server''} Cuff, J. A.,
3187 Clamp, M. E., Siddiqui, A. S., Finlay, M. and Barton, G. J. (1998) {\sl
3188 Bioinformatics} {\bf 14}, 892-893} server at the University of
3189 Dundee\footnote{http://www.compbio.dundee.ac.uk/www-jpred/}. The behaviour of
3190 this calculation depends on the current selection:
3191 \begin{list}{$\circ$}{}
3192 \item If nothing is selected, Jalview will check the length of each alignment row to determine if the visible sequences in the view are aligned.
3193 \begin{list}{-}{}
3194               \item If all rows are the same length (often due to the
3195               application of the {\sl Edit $\Rightarrow$ Pad Gaps} option), then
3196               a JPred prediction will be run for the first sequence in the
3197               alignment, using the current alignment as the profile to use for prediction.
3198               \item  Otherwise, just the first sequence will be submitted for a
3199               full JPred prediction.
3200 \end{list}
3201 \item If just one sequence (or a region in one sequence) has been selected, it
3202 will be submitted to the automatic JPred prediction server for homolog detection
3203 and prediction.
3204 \item If a set of sequences are selected, and they appear to be aligned using
3205 the same criteria as above, then the alignment will be used for a JPred
3206 prediction on the first sequence in the set (that is, the one that appears first in the alignment window).
3207 \end{list}
3208 Jpred is launched in the same way as the other web services. Select {\sl Web
3209 Services $\Rightarrow$ Secondary Structure Prediction $\Rightarrow$ JNet
3210 Secondary Structure Prediction}\footnote{JNet is the Neural Network based
3211 secondary structure prediction method that the JPred server uses.} from the
3212 alignment window menu (Figure \ref{jpred}).
3213 A status window opens to inform you of the progress of the job. Upon completion, a new alignment window opens and the Jpred
3214 predictions are included as annotations. Consult the Jpred documentation for
3215 information on interpreting these results.
3216
3217 \begin{figure}[htbp]
3218 \begin{center}
3219 \includegraphics[width=2.25in]{images/jpred1.pdf}
3220 \includegraphics[width=3in]{images/jpred2.pdf}
3221 \caption{{\bf Secondary Structure Prediction} Status (left) and results (right) windows for JNet predictions. }
3222 \label{jpred}
3223 \end{center}
3224 \end{figure}
3225
3226 \subsubsection{Hidden Columns and JNet Predictions}
3227 \label{hcoljnet}
3228 Hidden columns can be used to exclude parts of a sequence or profile from the
3229 input sent to the JNet service. For instance, if a sequence is known to include
3230 a large loop insertion, hiding that section prior to submitting the JNet
3231 prediction can produce different results. In some cases, these secondary structure predictions can be more reliable for sequence on either side of the insertion\footnote{This, of course, cannot be guaranteed.}. Prediction results returned from the service will
3232 be mapped back onto the visible parts of the sequence, to ensure a single frame
3233 of reference is maintained in your analysis.
3234
3235 \section{Protein Disorder Prediction}
3236 \label{protdisorderpred}
3237
3238 Disordered regions in proteins were classically thought to correspond to
3239 ``linkers'' between distinct protein domains, but disorder can also play a role in
3240 function. The {\sl Web Services $\Rightarrow$ Disorder} menu in the alignment window
3241 allows access to protein disorder prediction services provided by the configured
3242 JABAWS servers. 
3243
3244 \subsection{Disorder Prediction Results}
3245 Each service operates on sequences in the alignment to identify regions likely
3246 to be unstructured or flexible, or alternately, fold to form globular domains.
3247 As a consequence, disorder predictor results include both sequence features and
3248 sequence associated alignment annotation rows. Section \ref{featannot} describes
3249 the manipulation and display of these data in detail, and {\bf Figure
3250 \ref{alignmentdisorder}} demonstrates how sequence feature shading and
3251 thresholding (described in Section \ref{featureschemes}) can be used to
3252 highlight differences in disorder prediction across aligned sequences.
3253
3254 \exercise{Secondary Structure Prediction}{
3255 \label{secstrpredex}
3256 \exstep{ Open the alignment at \url{http://www.jalview.org/tutorial/alignment.fa}. Select the sequence {\sl FER\_MESCR} by clicking on the sequence ID. Then select {\sl Web Services $\Rightarrow$ Secondary Structure Prediction $\Rightarrow$ JNet Secondary Structure Prediction} from the alignment window menu. A status window will appear and after some time (about 2-4 min) a new window with the JPred prediction will appear. Note that the number of sequences in the results window is many more than in the original alignment as JNet performs a PSI-BLAST search to expand the prediction dataset.
3257 }
3258 % TODO: check how long this takes - about 2 mins once it gets on the cluster.
3259 \exstep{
3260 Select a different sequence and perform a JNet prediction in the same way. There will probably be minor differences in the predictions.
3261 }
3262 \exstep{
3263 Select the second sequence prediction, and copy and paste it into the first
3264 prediction window. You can now compare the two predictions. Jnet secondary structure prediction annotations are examples of {\bf sequence-associated alignment annotation}.
3265 % which is described in Section \ref{seqassocannot} below.
3266 }
3267 \exstep{
3268 Select and hide some columns in one of the profiles that were returned from the JNet service, and then submit the profile for prediction again. 
3269 }
3270 \exstep{
3271 When you get the result, verify that the prediction has not been made for the
3272 hidden parts of the profile, and that the JPred reliability scores differ from the prediction made on the full profile.
3273
3274 {\sl Note: you may want to keep this data for use in exercise \ref{viewannotfileex}.}
3275 }
3276 \exstep{
3277 In the original alignment that you loaded in step 1, {\bf select all} sequences,
3278 then open the {\bf Sequence ID $\Rightarrow$ Selection } submenu and select the
3279 {\bf Add Reference Annotation} option.
3280
3281 The JNet predictions for the sequences should now be visible in the original
3282 alignment.} }
3283
3284 \begin{figure}[htbp]
3285 \begin{center}
3286 \includegraphics[width=5in]{images/disorderpred.pdf}
3287 \caption{{\bf Shading alignment by sequence disorder}. Alignment of Interleukin IV homologs coloured with Blosum62 with protein disorder prediction sequence features overlaid, shaded according to their score. Borderline disordered regions appear white, reliable predictions are either Green or Brown depending on the type of disorder prediction. }
3288 \label{alignmentdisorder}
3289 \end{center}
3290 \end{figure}
3291
3292 \subsubsection{Navigating Large Sets of Disorder Predictions}
3293
3294 {\bf Figure \ref{alignmentdisorderannot}} shows a single sequence annotated with
3295 a range of disorder predictions. Disorder prediction annotation rows are
3296 associated with a sequence in the same way as secondary structure prediction
3297 results. When browsing an alignment containing large numbers of disorder
3298 prediction annotation rows, clicking on the annotation row label will highlight
3299 the associated sequence in the alignment display, and double clicking will
3300 select that sequence.
3301
3302 \begin{figure}[htbp]
3303 \begin{center}
3304 \includegraphics[width=5in]{images/disorderpredannot.pdf}
3305 \caption{{\bf Annotation rows for several disorder predictions on a sequence}. A
3306 zoomed out view of a prediction for a single sequence. The sequence is shaded to highlight disordered regions (brown and grey), and the line plots below the Sequence show the raw scores for various disorder predictors. Horizontal lines on each graph mark the level at which disorder predictions become significant. }
3307 \label{alignmentdisorderannot}
3308 \end{center}
3309 \end{figure}
3310
3311
3312 \subsection{Disorder Predictors provided by JABAWS 2.0}
3313 For full details of each predictor and the results that Jalview can display,
3314 please consult
3315 \href{http://www.jalview.org/help/html/webServices/proteinDisorder.html}{Jalview's
3316 protein disorder service documentation}. Short descriptions of the methods provided in JABAWS 2.0 are given below:
3317
3318 \subsubsection{DisEMBL}
3319 \href{http://dis.embl.de/}{DisEMBL (Linding et al., 2003)} is a set of machine-learning based predictors trained to
3320 recognise disorder-related annotation found on PDB structures.
3321
3322 \textbf{COILS} Predicts
3323 loops/coils according to DSSP
3324 definitions\footnote{DSSP Classifications of secondary structure are: $\alpha$-helix (H), 310-helix (G), $\beta$-strand (E)
3325 are ordered, and all other states ($\beta$-bridge (B), $\beta$-turn (T), bend (S),
3326 $\pi$-helix (I), and coil (C)) considered loops or coils.}. Features mark range(s) of
3327 residues predicted as loops/coils, and annotation row gives raw value
3328 for each residue. Value over 0.516 indicates loop/coil.
3329
3330 \textbf{HOTLOOPS} constitute a refined subset of \textbf{COILS}, namely those loops with
3331 a high degree of mobility as determined from C$\alpha$ temperature factors (B
3332 factors). It follows that highly dynamic loops should be considered
3333 protein disorder. Features mark range(s) of residues predicted to
3334 be hot loops and annotation row gives raw value for each
3335 residue. Values over 0.6 indicates hot loop.
3336
3337 \textbf{REMARK465} ``Missing
3338 coordinates in X-ray structure as defined by remark465 entries in PDB.
3339 Nonassigned electron densities most often reflect intrinsic disorder,
3340 and have been used early on in disorder prediction.'' Features give
3341 range(s) of residues predicted as disordered, and annotation rows gives
3342 raw value for each residue. Values over 0.1204 indicates disorder.
3343
3344 \subsubsection{RONN {\sl a.k.a.} Regional Order Neural Network}
3345 \href{http://www.strubi.ox.ac.uk/RONN}{RONN} employs an approach
3346 known as the `bio-basis' method to predict regions of disorder in
3347 sequences based on their local similarity with a gold-standard set of
3348 disordered protein sequences. It yields a set of disorder prediction
3349 scores, which are shown as sequence annotation below the alignment.
3350
3351 \textbf{JRonn}\footnote{JRonn denotes the score for this server because JABAWS
3352 runs a Java port of RONN developed by Peter Troshin and distributed as
3353 part of \href{http://www.biojava.org/}{Biojava 3}} Annotation Row gives RONN score for each residue in
3354 the sequence. Scores above 0.5 identify regions of the protein likely
3355 to be disordered.
3356
3357 \subsubsection{IUPred}
3358 \href{http://iupred.enzim.hu/Help.php}{IUPred} employs
3359 an empirical model to estimate likely regions of disorder. There are
3360 three different prediction types offered, each using different
3361 parameters optimized for slightly different applications. It provides
3362 raw scores based on two models for predicting regions of `long
3363 disorder' and `short disorder'. A third predictor identifies regions
3364 likely to form structured domains.
3365
3366 \textbf{Long disorder} Annotation rows predict
3367 context-independent global disorder that encompasses at least 30
3368 consecutive residues of predicted disorder. A 100 residue
3369 window is used for calculation. Values above 0.5 indicates the residue is
3370 intrinsically disordered.
3371
3372 \textbf{Short disorder} Annotation rows predict for short, (and
3373 probably) context-dependent, disordered regions, such as missing
3374 residues in the X-ray structure of an otherwise globular protein.
3375 Employs a 25 residue window for calculation, and includes adjustment
3376 parameter for chain termini which favors disorder prediction at the
3377 ends. Values above 0.5 indicate short-range disorder.
3378
3379 \textbf{Structured domains} are marked with sequence Features. These highlight
3380 likely globular domains useful for structure genomics investigation. Post-analysis of disordered region profile to find continuous regions
3381 confidently predicted to be ordered. Neighbouring regions close to
3382 each other are merged, while regions shorter than the minimal domain
3383 size of at least 30 residues are ignored.
3384
3385 \subsubsection{GLOBPLOT}
3386 \href{http://globplot.embl.de/}{GLOBPLOT} defines regions of
3387 globularity or natively unstructured regions based on a running sum of
3388 the propensity of residues to be structured or unstructured. The
3389 propensity is calculated based on the probability of each amino acid
3390 being observed within well defined regions of secondary structure or
3391 within regions of random coil. The initial signal is smoothed with a
3392 Savitzky-Golay filter, and its first order derivative
3393 computed. Residues for which the first order derivative is positive
3394 are designated as natively unstructured, whereas those with negative
3395 values are structured.
3396
3397 {\bf Disordered region} sequence features are created marking mark range(s) of residues with positive first order derivatives, and 
3398 \textbf{Globular Domain} features mark long stretches of order. \textbf{Dydx} annotation rows gives the first order derivative of smoothed score. Values above 0 indicates
3399 residue is disordered. 
3400
3401 \textbf{Smoothed Score and Raw Score} annotation rows give the smoothed and raw scores used to create the differential signal that
3402 indicates the presence of unstructured regions. These are hidden
3403 by default, but can be shown by right-clicking on the alignment
3404 annotation panel and selecting \textbf{Show hidden annotation}.
3405
3406 \exercise{Protein Disorder Prediction}{
3407 %\label{protdispredex}
3408
3409 \exstep{Open the alignment at
3410 \url{http://www.jalview.org/tutorial/interleukin7.fa}. } also available  at
3411
3412
3413 \url{http://www.jalview.org/tutorial/training-materials/2014/Dundee/Oct/interleukin7.fa}
3414
3415 \exstep{Run the DisEMBL disorder predictor {\slvia} the {\slWeb Services
3416 $\Rightarrow$ Disorder Prediction } submenu.}
3417
3418 \exstep{Use {\sl Sequence ID $\Rightarrow$ Structure $\Rightarrow$ Discover PDB
3419 IDs} to retrieve all the PDB structures for the sequences.}
3420
3421 \exstep{Open and align
3422 the structures for all sequences.
3423
3424 {\sl Hint: see \ref{viewAllStructures} to see how to do this.}}
3425
3426 \exstep{Compare the disorder predictions to the structure data by mapping any
3427 available temperature factors to the alignment {\sl via} the {\sl Sequence ID
3428 Popup $\Rightarrow$ Selection $\Rightarrow$ Add reference annotation} option.}
3429
3430 \exstep{Apply the IUPred disorder prediction method} 
3431 \exstep{Use the {\sl Per
3432 sequence option} in the {\sl Colour $\Rightarrow$ By annotation \ldots} dialog to shade
3433 the sequences by the long and short disorder predictors.
3434 Do the two methods agree with the structure ?}}
3435
3436 \chapter{DNA and RNA Sequences}
3437 \label{dnarna}
3438 \section{Working with DNA}
3439 \label{workingwithnuc}
3440 Jalview was originally developed for the analysis of protein sequences, but
3441 now includes some specific features for working with nucleic acid sequences
3442 and alignments. Jalview recognises nucleotide sequences and alignments based on
3443 the presence of nucleotide symbols [ACGT] in greater than 85\% of the
3444 sequences. Built in codon-translation tables can be used to translate ORFs
3445 into peptides for further analysis. EMBL nucleotide records retrieved {\sl via} the
3446 sequence fetcher (see Section \ref{fetchseq}) are also parsed in order to
3447 identify codon regions and extract peptide products. Furthermore, Jalview
3448 records mappings between protein sequences that are derived from regions of a
3449 nucleotide sequence. Mappings are used to transfer annotation between
3450 nucleic acid and protein sequences, and to dynamically highlight regions in
3451 one sequence that correspond to the position of the mouse pointer in another.
3452 %TODO Working with Nucleic acid sequences and structures.
3453 \subsection{Alignment and Colouring}
3454
3455 Jalview provides a simple colourscheme for DNA bases, but does not apply any
3456 specific conservation or substitution score model for the shading of
3457 nucleotide alignments. However, pairwise alignments performed using the {\sl Calculate $\Rightarrow$ Pairwise Alignment
3458 \ldots} option will utilise an identity score matrix to calculate alignment
3459 score when aligning two nucleotide sequences.
3460
3461 \subsubsection{Aligning Nucleic Acid Sequences}
3462
3463 Jalview has limited knowledge of the capabilities of the programs that
3464 are made available to it {\sl via} web services, so it is up to you, the user,
3465 to decide which service to use when working with nucleic acid sequences. The
3466 table shows which alignment programs are most appropriate
3467 for nucleotide alignment. Generally, all will work, but some may be more suited
3468 to your purposes than others. We also note that none of these include
3469 support for taking RNA secondary structure prediction into account when aligning
3470 sequences (but will be providing services for this in the future!) 
3471 \begin{table}{}
3472 \centering
3473 \begin{tabular}{|l|c|l|}
3474 \hline
3475 Program& NA support& Notes\\
3476 \hline
3477 ClustalW& Yes&\begin{minipage}[f]{3in}
3478 Default is to autodetect nucleotide
3479 sequences. Editable parameters include nucleotide substitution matrices and
3480 distance metrics.
3481 \end{minipage}
3482
3483 \\
3484 \hline
3485
3486 Muscle& Yes (treat U as T)&\begin{minipage}[f]{3in}
3487 Default is to autodetect nucleotide
3488 sequences. Editable parameters include nucleotide substitution matrices and
3489 distance metrics.
3490 \end{minipage}
3491
3492 \\
3493 \hline
3494
3495 MAFFT& Yes&\begin{minipage}[f]{3in}
3496 Will autodetect nucleotide sequences and use a hardwired substitution model
3497 (all amino-acid sequence related parameters are ignored). Unknown whether
3498 substitution model treats Uracil specially.
3499 \end{minipage}
3500
3501 \\
3502 \hline
3503
3504 ProbCons& No&\begin{minipage}[f]{3in}
3505 ProbCons has no special support for aligning nucleotide sequences. Whilst an
3506 alignment will be returned, it is unlikely to be reliable.
3507 \end{minipage}
3508
3509 \\
3510 \hline
3511
3512 T-COFFEE& Yes&\begin{minipage}[f]{3in}
3513 Sequence type is automatically detected and an appropriate
3514 parameter set used as required. A range of nucleotide specific
3515 score models are available.\end{minipage}
3516
3517 \\\hline
3518 \end{tabular}
3519 \caption{{\bf JABAWS Alignment programs suitable for aligning nucleic acid
3520 sequences.} All JABAWS alignment services will return an alignment if provided
3521 with RNA or DNA sequences, with varying reliability.}
3522 \label{nucleomsatools}
3523 \end{table}
3524
3525 \subsection{Translate cDNA}
3526
3527 The {\sl Calculate $\Rightarrow$ Translate cDNA} function in the alignment
3528 window is only available when working with a nucleic acid alignment. It uses the standard codon translation table given in the online help documentation to translate a nucleotide alignment, or the currently selected region, into a set of aligned peptide sequences. Any features or annotation present on the nucleotide alignment will also be translated, allowing DNA alignment analysis results to be transferred on to peptide products for further investigation.
3529
3530 \subsection{Linked DNA and Protein Views}
3531
3532 \parbox{3.5in}{
3533 Views of alignments involving DNA sequences are linked to views of alignments containing their peptide products in a similar way to views of protein sequences and views of their associated structures. Peptides translated from cDNA that have been fetched from EMBL records for DNA contigs are linked to their `parent' coding regions. Mousing over a region of the peptide highlights codons in views showing the original coding region.
3534 }\parbox{3in}{
3535 \begin{center}
3536 %\begin{figure}[htbp]
3537
3538 \includegraphics[width=2.8in]{images/cdnatranslinkedwin.pdf}
3539
3540 %\caption{{\bf Linked DNA and Protein Views.} }
3541 %\end{figure}
3542 \end{center}
3543 }
3544
3545
3546 \subsection{Coding Regions from EMBL Records}
3547
3548 Many EMBL records that can be retrieved with the sequence fetcher contain exons.
3549 Coding regions will be marked as features on the EMBL nucleotide sequence, and
3550 Uniprot database cross references will be listed in the tooltip displayed when
3551 the mouse hovers over the sequence ID. Uniprot database cross references
3552 extracted from EMBL records are sequence cross references, and associate a
3553 Uniprot sequence's coordinate system with the coding regions annotated on the
3554 EMBL sequence. Jalview utilises cross-reference information in two ways.
3555 \subsubsection{Retrieval of Protein or DNA Cross References}
3556 The {\sl Calculate $\Rightarrow$ Get Cross References } function is only available when Jalview recognises that there are protein/DNA cross-references present on sequences in the alignment. When selected, it retrieves the cross references from the alignment's dataset (a set of sequence and annotation metadata shared between alignments) or using the sequence database fetcher. This function can be used for EMBL sequences containing coding regions to open the Uniprot protein products in a new alignment window. The new alignment window that is opened to show the protein products will also allow dynamic highlighting of codon positions in the EMBL record for each residue in the protein product(s).
3557
3558 \subsubsection{Retrieval of Protein DAS Features on Coding Regions}
3559
3560 The Uniprot cross-references derived from EMBL records can be used by Jalview to visualize protein sequence features directly on nucleotide alignments. This is because the database cross references include the sequence coordinate mapping information to correspond regions on the protein sequence with that of the nucleotide contig. Jalview will use the Uniprot accession numbers associated with the sequence to retrieve features, and then map them onto the nucleotide sequence's coordinate system using the coding region location.
3561
3562 \begin{figure}[htbp]
3563 \begin{center}
3564 \label{dnadasfeatures}
3565 \includegraphics[width=5in]{images/dnadasfeatures.pdf}
3566
3567 \caption{Uniprot and PDB sum features retrieved {\sl via} DAS and mapped onto
3568 coding regions of EMBL record V00488 (an earlier version of Jalview is shown
3569 here).}
3570
3571 \end{center}
3572 \end{figure}
3573
3574 \exercise{Visualizing Protein Features on Coding Regions}
3575 {
3576 \exstep{Use the sequence fetcher to retrieve EMBL record D49489.}
3577 \exstep{Ensure that {\sl View $\Rightarrow$ Show Sequence Features} is checked and change the 
3578 alignment view format to Wrapped mode so the distinct exons can be seen.}
3579 \exstep{Open the {\sl DAS Settings} tab in the {\sl Sequence Feature Settings\ldots} 
3580 window {\sl View $\Rightarrow$ Features setting}
3581 and fetch features for D49489 from the Uniprot reference server,
3582 and any additional servers that work with the Uniprot coordinate system.}
3583 \exstep{Mouse over the features retrieved, note that they have been mapped onto the coding regions, and in some cases broken into several parts to cover the distinct exons.}
3584 \exstep{Open a new alignment view containing the Uniprot protein product 
3585 with {\sl Calculate $\Rightarrow$ Get Cross References $\Rightarrow$ Uniprot } 
3586 and examine the database references and sequence features. Experiment with the 
3587 interactive highlighting of codon position for each residue.}
3588 }
3589 % \section{Working with RNA}
3590 % \label{workingwithrna}
3591
3592 % \subsection{RNA specific alignment colourschemes}
3593 % \label{rnacolschemes}
3594
3595 % \subsection{Exploring RNA secondary structure with VARNA}
3596 % \label{varna}
3597
3598 % \subsection{RNA Secondary structure annotation}
3599 % \subsubsection{Interactive creation of RNA secondary structure annotation}
3600 % \label{rnasecstrediting}
3601
3602 % \subsubsection{Import and export of RNA secondary structure annotation}
3603 % \label{rnasecstrio}
3604
3605
3606 % \chapter{Advanced Jalview}
3607
3608 % \section{Customising Jalview}
3609 % \subsection{Setting preferences}
3610
3611 % The Jalview Desktop stores configuration and history information in a file stored in the users home directory, called `.jalview\_properties'. Many of the options stored in this file are presented in the {\sl Desktop $\Rightarrow$ Tools $\Rightarrow$ Preferences\ldots} dialog. These preferences include default settings for : {\bf Visual} layout settings for alignment views and controlling the display of the default alignment, {\bf Connection} preferences such as the standard set of URL paths that are available from the links menu and the URL which is opened when a Sequence's ID is double clicked, {\bf Editing} settings like {\sl Pad Gaps} and autocalculation of consensus, {\bf Output} settings control the degree of meta-information written in alignment files and mode of EPS Figuregeneration, and finally the {\bf Das Settings} which allows the default DAS sources to be configured. 
3612
3613 % \subsection{Adding your own URL links}
3614
3615 % \subsection{Working with Databases and Database Cross References}
3616 % \label{getcrossrefs}
3617
3618 % {\sl Calculations $\Rightarrow$ Get Cross References }
3619
3620 % \section{Jalview IO Interface}
3621 % \subsection{Multiple views}
3622 % \subsection{Annotation files}
3623 % \subsection{Feature files}
3624 % \subsection{Moving sequence associated annotation}
3625 % \subsection{Propagating features}
3626 % \section{Structures}
3627 % \subsection{Working with Modeller files}
3628 % \subsection{Using local PDB files}
3629 % \section{Pairwise alignments}
3630
3631 \section{Working with RNA}
3632 Jalview allows the creation of RNA secondary structure annotation, and includes
3633 the VARNA secondary structure viewer for the display of RNA base pair diagrams.
3634 It also allows the extraction of RNA secondary structure from 3D data when
3635 available.
3636
3637 \subsection{Performing RNA Secondary Structure Predictions}
3638 Secondary structure consensus calculations can be performed by enabling the
3639 VIENNA service {\sl via} the {\sl Web Services $\Rightarrow$ Secondary
3640 Structure} menu. These consensus structures are created by analysing the
3641 covariation patterns in all visible sequences on the alignment. For more
3642 information see the VIENNA documentation.
3643
3644 \begin{figure}[htbp]
3645 \begin{center}
3646 \label{rnaviennaservice}
3647 \includegraphics[width=5in]{images/rnaViennaServiceWindow.pdf}
3648
3649 \caption{Secondary structure consensus calculations can be performed by enabling the
3650 VIENNA service {\sl via} the {\sl Web Services $\Rightarrow$ Secondary
3651 Structure} menu.}
3652
3653 \end{center}
3654 \end{figure}
3655
3656 \begin{figure}[htbp]
3657 \begin{center}
3658 \label{rnaviennaaltpairs}
3659 \includegraphics[width=5in]{images/rnaViennaAlternateProbs.pdf}
3660
3661 \caption{VIENNA can calculate alternate RNA base pairing probabilities. These
3662 are shown in Jalview as tool-tips on the RNA secondary structure probability
3663 score.}
3664
3665 \end{center}
3666 \end{figure}
3667
3668
3669 \exercise{Viewing RNA Structures}
3670 { \label{viewingrnaex}
3671
3672 \exstep{Import RF00162 from Rfam (Full) using Fetch sequence(s) option in File
3673 menu.}
3674 \exstep{Select {\sl Colour by RNA Helices} to shade the alignment by
3675 the secondary structure annotation provided by Rfam.}
3676
3677 \exstep{Open VARNA with {\sl Structure $\Rightarrow$ View Structure
3678 $\Rightarrow$ RNA Secondary Structure}.
3679 In the VARNA Structures Manager toggle between (i) secondary structure
3680 (alignment) (with gaps) and (ii) trimmed secondary structure (alignment). 
3681 Explore the difference between trimmed and untrimmed views.
3682 Click on different residues and located them in the sequence alignment window.}
3683
3684 \exstep{In the VARNA Structures Manager, right click on display window to
3685 bring up the pop up context menu. Investigate option within File, Export, Display
3686 and Edit sections.}
3687
3688 \exstep{Perform a secondary structure prediction in {\sl Web Services}. Enable
3689 the VIENNA consensus calculation via the {\sl Web Services} menu and select
3690 Change RNAAIiFold settings option.}
3691 % Compare this with the annotationline provided by Rfam.
3692
3693 \exstep{Edit the VIENNA calculation settings to show
3694 Base Pair probabilities. Explore how editing the alignment affects the consensus
3695 calculation.}
3696
3697 \exstep{Import 2GIS from PDB database using Fetch sequence(s) option.}
3698 \exstep{Click on a sequence in Sequence ID panel and select {\sl Structure
3699 $\Rightarrow$ View Structure $\Rightarrow$ 2GIS}, to view the structure in Jmol
3700 window. Click on different residues and located them in the sequence alignment window.}
3701 %\exstep{Add and link a Jmol structure view
3702 %for Bacillus\_amyloliquef.9 for 3NPB (from the PDB). Display the secondary
3703 %structure along-side the consensus structure for the alignment by adding
3704 %reference annotation from the 3D structure.
3705
3706 %{\sl Hint: You need to make sure the RNAview service is enabled in your {\sl
3707 %Structure} preferences to obtain RNA secondary structure annotation from PDB
3708 %files.}}
3709
3710  }
3711
3712 \chapter{Webservices}
3713 \label{jvwebservices}
3714 The term ``Webservices'' refers to a variety of data exchange
3715 mechanisms based on HTTP.\footnote{HTTP: Hyper-Text Transfer Protocol.} 
3716
3717 \parbox[c]{4.5in}{Jalview can exploit public webservices to access databases
3718 remotely, and also submit data to public services by opening pages with your web browser. These types of
3719 services are `one-way', {\sl i.e.} data is either sent to the webservice or
3720 retrieved from it by Jalview. The desktop application can also interact
3721 with `two-way' remote analysis services in order to offload computationally
3722 intensive tasks to High Performance Computing facilities. Most of these two-way
3723 services are provided by {\bf Ja}va {\bf B}ioinformatics {\bf A}nalysis {\bf
3724 W}eb {\bf S}ervice (JABAWS) servers\footnote{See
3725 http://www.compbio.dundee.ac.uk/jabaws for more information and to download
3726 your own server.}, which provides an easily installable system for performing
3727 a range of bioinformatics analysis tasks. }
3728 \parbox[c]{1.75in}{\includegraphics[width=1.65in]{images/wsmenu.pdf}}
3729
3730 \subsection{One-Way Web Services}
3731
3732 There are two types of one way service in Jalview. Database services,
3733 which were introduced in in Section \ref{fetchseq}, provide sequence and
3734 alignment data. They can also be used to add sequence IDs to an alignment
3735 imported from a local file, prior to further annotation retrieval, as described
3736 in Section \ref{featuresfromdb}. A second type of one way service is provided
3737 by Jalview's DAS sequence feature retrieval system, which is described
3738 in Section \ref{dasfretrieval}. 
3739 % The final type of one way service are sequence
3740 % and ID submission services.
3741 % exemplified by the `Envision2 Services' provided
3742 % by the ENFIN Consortium\footnote{ENFIN is the European Network for Functional
3743 % INtegration. Please see http://www.enfin.org for more information. }.
3744
3745 % \subsubsection{One-way submission services}
3746 % Jalview can use the system's web browser to submit sets of sequences and
3747 % sequence IDs to web based applications. Single sequence IDs can be passed to
3748 % a web site using the user definable URL links listed under the {\sl
3749 % Links} submenu of the sequence ID popup menu. These are configured
3750 % in the {\sl Connections} tab of the {\sl Preferences} dialog box.
3751
3752 % The Envision 2 services presented in the webservice menu provides are the first
3753 % example of one-way services where multiple sequences or sequence IDs can be
3754 % sent. The {\sl Web service $\Rightarrow$ Envision 2 Services} menu entry
3755 % provides two sub-menus that enable you to submit the sequences or IDs
3756 % associated with the alignment or just the currently selected sequences to one
3757 % of the Envision2 workflows. Selecting any one will open a new browser window on
3758 % the Envision2 web application. The menu entries and their tooltips provide
3759 % details of the Envision2 workflow and the dataset set that will be submitted
3760 % ({\sl i.e.} the database reference type, or associated sequence subset). Please
3761 % note, due to technical limitations, Jalview can currently only submit small
3762 % numbers of sequences to the workflows - if no sequence or ID submissions are
3763 % presented in the submenus, then try to select a smaller number of sequences to
3764 % submit. 
3765
3766 \subsection{Remote Analysis Web Services}
3767 Remote analysis services enable Jalview to use external computational
3768 facilities. There are currently three types of service - multiple sequence
3769 alignment, protein secondary structure prediction, and alignment analysis.
3770 Many of these are provided by JABA servers, which are described at the end of
3771 this section. In all cases, Jalview will construct a job based on the alignment
3772 or currently selected sequences, ask the remote server to run the job, monitor
3773 status of the job and, finally, retrieve the results of the job and display
3774 them. The Jalview user is kept informed of the progress of the job through a
3775 status window.
3776
3777 Currently, web service jobs and their status windows are not stored in Jalview
3778 Project Files\footnote{This may be rectified in future versions.}, so it is
3779 important that you do not close Jalview whilst a job is running. It is also
3780 essential that you have a continuous network connection in order to
3781 successfully use web services from Jalview, since it periodically checks the
3782 progress of running jobs.
3783
3784
3785 \subsection{JABA Web Services for Sequence Alignment and Analysis}
3786 \label{jabaservices}
3787 JABA stands for ``JAva Bioinformatics Analysis'', which is a system developed
3788 by Peter Troshin and Geoff Barton at the University of Dundee for running
3789 computationally intensive bioinformatics analysis programs. A JABA installation
3790 typically provides a range of JABA web services (JABAWS) for use by other
3791 programs, such as Jalview.
3792
3793 Exercises in the remainder of this section will demonstrate the simplest way of
3794 installing JABA on your computer, and configuring Jalview so it can access the JABA services. If you
3795 need any further help or more information about the services, please go to the
3796 \href{http://www.compbio.dundee.ac.uk/jabaws}{JABAWS home page}.
3797 %% \subsubsection{Aims}
3798 %%  \begin{list}{$\bullet$}{}
3799 %%  \item Gain experience using the different alignment services provided by
3800 % JABA
3801 %%\item Learn about the way that Jalview stores user presets for JABA services
3802 %%\item Learn how to install JABA services and configure Jalview to access them
3803 %%\end{list}
3804
3805 \subsection{Changing the Web Services Menu Layout}
3806 \label{changewsmenulayout}
3807 If you are working with a lot of different JABA services, you may wish to change
3808 the way Jalview lays out the web services menu. You can do this from the Web
3809 Services tab of the {\sl Preferences} dialog box.
3810
3811 \exercise{Changing the Layout of the Web Services Menu}{
3812 \label{changewsmenulayoutex}
3813 \exstep{Make sure you have loaded an alignment into Jalview, and examine the
3814 current layout of the alignment window's {\sl Web Service} menu.}
3815 \exstep{Open the preferences dialog box and select the web services tab.}
3816 \exstep{Ensure the {\sl Enable JABAWS services} checkbox is selected, and unselect
3817 the {\sl Enable Enfin Services} checkboxes.}
3818 \exstep{Hit {\sl Refresh Services} to update the web services menu -- once the
3819 progress bar has completed, open the {\sl Web Service} menu to view the changes.}
3820 \exstep{Select the {\sl Index by host} checkbox and refresh the services once again.
3821
3822 {\sl Observe the way the layout of the JABAWS Alignment submenu changes.}
3823 }
3824 \exstep{Do the same with the {\sl Index by type} checkbox.} 
3825 }
3826
3827 Jalview provides these options for configuring the layout of the  {\sl Web Service}
3828 menu because different Jalview users may have access to a different number of
3829 JABA services, and each will have their own preference regarding the layout of
3830 the menu.
3831
3832 \begin{figure}[htbc]
3833 \begin{center}
3834 \includegraphics[width=3in]{images/jvjabawsconfig.pdf}
3835 \caption{{\bf The Jalview Web Services preferences panel.} Options are provided
3836 for configuring the list of JABA servers that Jalview will use, enabling and
3837 disabling Enfin services, and configuring the layout of the web services
3838 menu.}
3839 \label{jvjabawsconfig}
3840 \end{center}
3841 \end{figure}
3842
3843
3844 \subsubsection{Testing JABA services}
3845 The JABAWS configuration dialog shown in Figure \ref{jvjabawsconfig} has colour
3846 codes to indicate whether the Desktop can access the server, and whether all
3847 services advertised by the server are functional. The colour codes are:
3848
3849 \begin{list}{$\bullet$}{}
3850   \item Red - Server cannot be contacted or reports a connection error.
3851   \item Amber - Jalview can connect, but one or more services are non-functional.
3852   \item Green - Server is functioning normally.
3853 \end{list}
3854   %TODO green and a tick, red and a cros, amber and a value indicating whether its all going
3855
3856 Test results from JABAWS are reported on Jalview's console output (opened from
3857 the Tools menu). Tests are re-run every time Jalview starts, and when the
3858 [Refresh Services] button is pressed on the Jalview JABAWS configuration panel.
3859
3860 \subsubsection{Resetting the JABA Services Setting to their Defaults}
3861 Once you have configured a JABAWS server and selected the OK button of the
3862 preferences menu, the settings will be stored in your Jalview preferences file,
3863 along with any preferences regarding the layout of the web services menu. If
3864 you should ever need to reset the JABAWS server list to its defaults, use the
3865 `Reset Services' button on the Web Services preferences panel.
3866
3867 \subsection{Running your own JABA Server}
3868 You can download and run JABA on your own machine using the `VMWare' or
3869 VirtualBox virtual machine environments. If you would like to learn how to do
3870 this, there are full instructions at the
3871 \href{http://www.compbio.dundee.ac.uk/jabaws/}{JABA web site}.
3872
3873 \exercise{Installing a JABA Virtual Machine on your Computer}{
3874 \label{jabawsvmex}{\sl This tutorial will demonstrate the simplest way of
3875 installing JABA on your computer, and configuring Jalview so it can access the JABA services. 
3876
3877 {\bf Prerequisites}
3878
3879 You will need a copy of VMWare Player/Workstation/Fusion on your machine.
3880 }
3881
3882 \exstep{If you do not have VMWare player installed, download it from
3883 www.vmware.com (this takes a few minutes -- you will need to register and wait
3884 for an email with a download link).}
3885 \exstep{Download the JABA virtual appliance archive called `jaba-vm.zip' from
3886 \textsf{http://www.compbio.dundee.ac.uk/jabaws/archive/jabaws-vm.zip}
3887
3888 WARNING: This is large (about 300MB) and will take some time to download.
3889 }
3890 \exstep{Unpack the archive's contents to a place on your machine with at least
3891 2GB of free space.
3892
3893 (On Windows, right click on the archive, and use the 'Extract archive..' option).
3894 }
3895 \exstep{Open the newly extracted directory and double click the VMWare virtual
3896 machine configuration file (jabaws.vcf). This will launch the VMWare player.
3897 }
3898 \exstep{Once VMWare player has started up, it may ask the question ``Did you move or copy
3899 this virtual appliance?'' -- select `Copy'.}
3900 \exstep{You may be prompted to download the VMWare linux tools. These are not
3901 necessary, so close the window or click on `Later'.}
3902 \exstep{You may also be prompted to install support for one or more devices (USB
3903 or otherwise). Say `No' to these options.}
3904 \exstep{Once the machine has loaded, it will display a series of IP addresses
3905 for the different services provided by the VM. Make a note of the JABAWS URL --
3906 this will begin with `http:' and end with `/jabaws''.}
3907 }
3908
3909 \exercise{Configuring Jalview to Access your new JABAWS Virtual Appliance}{
3910 \label{confnewjabawsappl}
3911 \exstep{Start Jalview (If you have not done so already).} 
3912 \exstep{Enable the Jalview Java Console by selecting its option from the Tools
3913 menu.
3914
3915 {\sl Alternately, use the System Java console if you have
3916 configured it to open when Jalview is launched, {\sl via} your system's Java
3917 preferences (under the `Advanced' tab on Windows).}}
3918 \exstep{Open the {\sl Preferences} dialog and locate the Web Services tab.}
3919 \exstep{Add the URL for the new JABAWS server you started in Exercise
3920 \ref{jabawsvmex} to the list of JABAWS urls using the `New Service
3921 URL' button.}
3922 \exstep{You will be asked if you want to test the service. Hit `Yes' to do this
3923 -- you should then see some output in the console window.
3924
3925 {\sl Take a close look at the output in the console.  What do you think is
3926 happening?}
3927 }
3928 \exstep{Hit OK to save your preferences -- you have now added a new JABA
3929 service to Jalview!}
3930 \exstep{Try out your new JABA services by loading the ferredoxin sequences from
3931 http://www.jalview.org/tutorial/alignment.fa}
3932 \exstep{Launch an alignment using one
3933 of the JABA methods provided by your server. It will be listed under the JABAWS Alignment submenu of the {\sl Web Service} menu on the alignment window.
3934
3935 {\sl Note: You can watch the JABA VM appliance's process working by opening the
3936 process monitor on your system. (On Windows XP, this involves right-clicking the
3937 system clock and opening the task manager -- then selecting the 'Processes' tab
3938 and sort by CPU).}
3939 }
3940 }
3941
3942 \end{document}