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