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