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