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