TODOs from the Jalview 2.11.1.1 course
[jalview-manual.git] / TheJalviewTutorial.tex
1 %\documentclass[a4paper,11pt]{report}
2 \documentclass[a4paper,11pt]{book}
3 \usepackage[format=hang,margin=10pt]{caption}
4 \usepackage{footnote}
5 \usepackage{graphicx}
6 \usepackage{fouriernc}
7 %\usepackage{amssymb}
8 \usepackage{epstopdf}
9 \usepackage{hyperref}
10 \usepackage{subfigure}
11 \DeclareGraphicsRule{.tif}{png}{.png}{`convert #1 `dirname #1`/`basename #1 .tif`.png}
12 \voffset = -0.5 in
13 \hoffset = -0.85 in
14 \textwidth = 6.5 in 
15 \textheight = 9.5 in 
16 \oddsidemargin = 1.20 in
17 \evensidemargin = 0.2 in
18 \topmargin = 0.0 in 
19 \headheight = 0.35 in
20 \headsep = 0.4 in
21 %\headheight = 0.0 in \headsep = 0.0 in
22 \parskip = 0.2in \parindent = 0.0in
23
24
25 \newtheorem{theorem}{Theorem}
26 \newtheorem{corollary}[theorem]{Corollary}
27 \newtheorem{definition}{Definition}
28
29
30 \title{Jalview 2.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, Ben Soares 
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.3
105 % post CLS lifesci course on 15th January
106 % draft. Remaining items are AACon, RNA visualization/editing and Protein disorder analysis exercises.
107
108
109 10th May 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 JalviewJS} that has the same core
147 visualization, editing and analysis capabilities as the desktop, without the
148 desktop's webservice. It is designed to be
149 opened in a web browser,\footnote{A demonstration version of Jalview (Jalview Micro
150 Edition) also runs on a mobile phone but the functionality is limited.} and includes a javascript API.
151
152
153 The Jalview Desktop provides access to protein and nucleic acid sequence, alignment and structure
154 databases, and includes the Jmol\footnote{ Provided under the LGPL licence at
155 \url{http://www.jmol.org}} and Chimera viewer for molecular structures, and the
156 VARNA\footnote{Provided under GPL licence at \url{http://varna.lri.fr}} program for the visualization of RNA secondary structure. It also
157 provides a graphical user interface for the multiple sequence alignment, conservation analysis 
158 and protein disorder prediction methods provided as {\bf Ja}va {\bf B}ioinformatics
159 {\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 
160 running bioinformatics programs that you can download and run on your own machine or cluster, or install on compute clouds.
161
162 \subsection{Jalview's Capabilities}
163 % TODO add references to appropriate sections for each capability described here.
164 Figure \ref{jvcapabilities} gives an overview of the main features of the
165 Jalview desktop application. Its primary function is the editing and
166 visualization of sequence alignments, and their interactive analysis. Tree
167 building, principal components analysis, physico-chemical property conservation
168 and sequence consensus analyses are built into the program. Web services enable
169 Jalview to access online alignment and secondary structure prediction programs,
170 as well as to retrieve protein and nucleic acid sequences, alignments, protein structures and sequence annotation. 
171 Sequences, alignments, trees, structures, features and alignment annotation may also be exchanged with the local filesystem. 
172 Multiple visualizations of an alignment may be worked on simultaneously, and the user interface provides a comprehensive set of controls for colouring and layout. 
173 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,
174 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 
175 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
176  figure generation capabilities for the preparation of alignments for publication.
177 \begin{figure}[htbp]
178 \begin{center}
179 \includegraphics[width=5.8in]{images/jvcapabilities.pdf}
180 \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.}
181 \label{jvcapabilities}
182 \end{center}
183 \end{figure}
184
185 \subsubsection{Jalview History}
186 Jalview was initially developed in 1996 by Michele Clamp, James Cuff, Steve
187 Searle and Geoff Barton at the University of Oxford and then the European
188 Bioinformatics Institute. Development of Jalview 2 was made possible with
189 eScience funding from the BBSRC\footnote{Biotechnology and Biological Sciences
190 Research Council grant  {\sl ``VAMSAS: Visualization and Analysis of Molecules,
191 Sequence Alignments and Structures"}, a joint project to enable interoperability
192 between Jalview, TOPALi and AstexViewer.} in 2004, enabling Andrew Waterhouse and
193 Jim Procter to re-engineer the original program to introduce contemporary developments
194 in bioinformatics and take advantage of the latest web and Java technology.
195 Jalview's development has been supported from 2009
196 onwards by BBSRC funding, and since 2014 by a
197 Wellcome Trust Biomedical Resource grant\footnote{Wellcome grant number 101651/Z/13/Z}. In 2010, 2011, and 2012, Jalview benefitted from the
198 \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/}}
199
200  
201 %TODO describe future plans in history ? not a good idea.
202 % Jalview continues to be one of the worlds most popular\footnote{and in the authors opinion, the best.} sequence alignment and analysis tools.
203
204 \subsubsection{Citing Jalview}
205 If you use Jalview in your work you should cite:\newline
206 {\sl "Jalview Version 2 - a multiple sequence alignment editor and analysis
207 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
208
209 This paper supersedes the original Jalview publication:\newline {\sl "The
210 Jalview Java alignment editor"} \newline Michele Clamp, James Cuff, Stephen M. Searle and Geoffrey J. Barton (2004) \newline {\sl Bioinformatics} {\bf 20} 426-427. 
211
212   
213 \subsection{About this Tutorial }
214
215 This tutorial is written in a manual format with short exercises where
216 appropriate. The first few sections concerns the
217 basic operation of Jalview and should be sufficient for those who want to
218 launch Jalview (Section \ref{startingjv}), open an alignment (Section
219 \ref{loadingseqs}), perform basic editing (Section
220 \ref{selectingandediting}), colouring (Section \ref{colours}), and produce
221 publication and presentation quality graphical output (Section \ref{layoutandoutput}).
222
223 The remaining sections of the manual cover the visualization and
224 analysis techniques available in Jalview. These include working
225 with the embedded Jmol molecular structure viewer (or UCSF Chimera), building
226 and viewing trees and Principal Components Analysis (PCA) plots, and using
227 trees for sequence conservation analysis. Section \ref{featannot} details the creation and visualization of sequence,
228 features and alignment annotation. The alignment and secondary structure prediction services are described
229 in detail in Sections \ref{msaservices} and \ref{protsspredservices}
230 respectively. Section \ref{workingwithnuc} discusses
231 specific features of use when working with nucleic acid sequences, such as translation and linking to protein coding regions, and 
232 the display and analysis of RNA secondary structure.  An overview of
233 the Jalview Desktop's webservices is given in Section \ref{jvwebservices}.
234
235 %^Chapter \ref{jalviewadvanced} The third chapter covers the detail^ of Jalview and is aimed at the user who is
236 %already familiar with Jalview operation but wants to get more out of their
237 %Jalview experience.
238
239 \subsubsection{Typographic Conventions}
240
241 Keystrokes using the special non-symbol keys are represented in the tutorial by
242 enclosing the pressed keys with square brackets ({\em e.g.} [RETURN] or [CTRL]).
243
244 Keystroke combinations are denoted with a `-' symbol ({\em
245 e.g.} [CTRL]-C means press [CTRL] and the `C' key simultaneously).
246
247 Menu options are given as a path from the menu
248 that contains them. For example {\sl File $\Rightarrow$ Input Alignment
249 $\Rightarrow$ From URL} means to select the `From URL' option from the `Input
250 Alignment' submenu of a window's `File' dropdown menu.
251
252 \section{Launching the Jalview Desktop Application}
253 \label{startingjv}
254 \begin{figure}[htbp]
255 \begin{center}
256 \includegraphics[width=4.5in]{images/download.pdf}
257 \caption{\bf Download page on the Jalview web site at www.jalview.org.}
258 \label{download}
259 \end{center}
260 \end{figure}
261
262 This tutorial is based on the Jalview
263 Desktop application. Much of the information will also be useful for users of
264 the JalviewJS, which has the same core editing, analysis and visualization capabilities. The Jalview Desktop, however, is much more powerful, and
265 includes additional support for interaction with external web services, and
266 production of publication quality graphics.
267
268 The Jalview Desktop can be run in two ways; as an application launched from the
269 web {\sl via} Java webstart, or as an application loaded onto your hard drive. 
270 The webstart version is launched from the `Launch Jalview Desktop
271 button' at the top right hand side of pages of the website 
272 \href{http://www.jalview.org}{(www.jalview.org)}.
273 To download the locally installable version, follow the links on the download
274 page
275 \href{http://www.jalview.org/download}{(www.jalview.org/download) }
276  (Figure \ref{download}).
277 These links will launch the latest stable release of Jalview.\par
278
279 %% this paragraph needs to be rewritten for the new signed certificate from Certum.
280
281 When the application is launched with webstart, dialogs may appear before
282 the application starts. If your browser is not set up to handle webstart, then
283 clicking the launch link may download a file that needs to be opened
284 manually, or prompt you to select the program to handle the webstart
285 file. If that is the case, you will need to locate the {\bf javaws} program
286 on your system\footnote{The file that is downloaded will have a type of {\bf
287 application/x-java-jnlp-file} or {\bf .jnlp}. The {\bf javaws} program that can run
288 this file is usually found in the {\bf bin} directory of your Java
289 installation}. Once java webstart has been launched, you may also be prompted to
290 accept a security certificate signed by the Barton Group.\footnote{On some
291 systems, the certificate may be signed by 'UNKNOWN'. In this case, clicking
292 through the dialogs to look at the detailed information about the certificate
293 should reveal it to be a Barton group certificate.} You can always trust us, so
294 click trust or accept as appropriate. The splash screen (Figure \ref{splash})
295 gives information about the version and build date that you are running,
296 information about later versions (if available), and the paper to cite in your
297 publications. This information is also available on the Jalview web site at 
298 \url{http://www.jalview.org}.
299
300 %[fig 2] 
301 \begin{figure}[htbp]
302
303 \begin{center}
304 \includegraphics[width=4.5in]{images/splash.pdf}
305 \caption{{\bf Jalview splash screen.}}
306 \label{splash}
307 \end{center}
308 \end{figure}
309
310 When Jalview starts it will automatically load an example alignment from the
311 Jalview site. This behaviour can be switched off in the Jalview Desktop
312 preferences dialog  by unchecking the open file option.
313 This alignment will look like the one in Figure \ref{startpage} (taken
314 from Jalview version 2.10.1).
315
316 %[figure 3 ]
317 \begin{figure}[htbp]
318 \begin{center}
319 \includegraphics[width=4in]{images/start.pdf}
320 \caption{{\bf Default startup for Jalview.}}
321 \label{startpage}
322 \end{center}
323 \end{figure}
324
325
326 \subsubsection{Jalview News RSS Feed}
327
328 Announcements are made available to users of the
329 Jalview Desktop {\sl via} the Jalview Newsreader. This window will open
330 automatically when new news is available, and can also be accessed {\sl via} the
331 Desktop's {\sl Tools $\Rightarrow$ Show Jalview News} menu entry. 
332
333 \begin{figure}[htbp]
334 \begin{center}
335 \includegraphics[height=3in]{images/jvrssnews.pdf}
336 \caption{{\bf The Jalview News Reader.} The newsreader opens automatically
337 when new articles are available from the Jalview Desktop's news channel.}
338 \label{jalviewrssnews}
339 \end{center}
340 \end{figure}
341
342
343 \exercise{Launching Jalview from the Jalview Website}{
344 \label{start}
345 \exstep{Open the Jalview web site
346 \href{http://www.jalview.org}{(www.jalview.org)}
347 in your web browser. Launch Jalview by clicking on the
348 pink `Launch Jalview' Desktop button in the top right hand corner. This
349 will download and open a jalview.jnlp webstart file.}
350 \exstep {Dialog boxes
351 will open and ask if you want to open the jalview.jnlp file as the file is an application downloaded from the
352 Internet, click {\sl Open}. (Note you may be asked to update Java, if you agree
353 then it will automatically update the Java software). As Jalview opens, four demo
354 Jalview windows automatically load.}
355 \exstep {If
356 you are having trouble, it may help changing the browser you are using, as the browsers and
357 its version may affect this process.}
358 \exstep{To disable opening of the demonstration project during the launch, go
359 to the {\sl Tools $\Rightarrow$
360 Preferences...} menu on the desktop. A `Preference'
361 dialog box opens, untick the box adjacent to the `Open file' entry in the
362 `Visual' preferences tab.
363 Click {\sl OK} to save the preferences.}
364 \exstep{Launch another Jalview workbench from the web site by clicking on the
365 pink Launch button.
366 The example alignment should not be loaded as Jalview starts up.}
367 \exstep{To reload the original demo file select the
368 {\em File$\Rightarrow$ From URL} entry in the Desktop menu. Click on
369 the URL history button (a downward arrow on the right hand side of the dialog
370 box) to view the files, select exampleFile\_2\_7.jar
371 (\url{http://www.jalview.org/examples/exampleFile_2_7.jar}) 
372 then click {\sl OK}.}
373 \begin{list}{$\circ$}{\newline
374   \newline {\bf
375   Notes}}
376   
377 \item {To make Jalview display a different alignment when it is launched, then go
378 to the {\sl Tools $\Rightarrow$
379 Preferences...} menu on the desktop. Then tick the `Open file' entry of `Visual'
380 preferences tab, type in the URL of the sequence you want to load.}
381 \item {You may want to move the jalview.jnlp file from your {\bf downloads} to another folder.}
382 \item {Opening Jalview via the jnlp file will also allow Jalview to be launched offline.}
383 \end{list}
384
385 {\bf See the video at:
386 \url{http://www.jalview.org/Help/Getting-Started}.}
387  }
388
389 \subsection{Getting Help}
390 \label{gettinghelp}
391 \subsubsection{Built in Documentation}
392 Jalview has comprehensive on-line help documentation. Select  {\sl Help
393 $\Rightarrow$ Documentation} from the main desktop window menu and a new window
394 will open (Figure \ref{help}). The appropriate topic can then be selected from the
395 navigation panel on the left hand side. To search for a specific topic, click
396 the `search' tab and enter keywords in the box which appears.
397
398
399 \begin{figure}[htbp]
400 \begin{center}
401 \parbox[c]{2in}{\centerline{\includegraphics[width=2.75in]{images/help1.pdf}}}
402 \parbox[c]{4in}{\includegraphics[width=4in]{images/help2.pdf}}
403 \caption{{\bf Accessing the built in Jalview documentation.}}
404 \label{help}
405 \end{center}
406 \end{figure}
407
408 \subsubsection{Email Lists}
409
410 The Jalview Discussion list ({\tt jalview-discuss@jalview.org}) provides a forum
411 for Jalview users and developers to raise problems and exchange ideas - any
412 problems, bugs, and requests for help should be raised here. The {\tt
413 jalview-announce@jalview.org} list can also be subscribed to if you wish to be
414 kept informed of new releases and developments. 
415
416 Archives and mailing list
417 subscription details can be found in the Jalview web site's \href{http://www.jalview.org/community}{community section}.
418
419
420 \section{Navigation}
421 \label{jvnavigation}
422 The major features of the Jalview Desktop are illustrated in Figure \ref{anatomy}. The alignment window is the primary window for editing and visualization, and can contain several independent views of the alignment being worked with. The other windows (Trees, Structures, PCA plots, etc) are linked to a specific alignment view. Each area of the alignment window has a separate context menu accessed by clicking the right mouse button.  
423
424  Jalview has two navigation and editing modes: {\bf normal mode}, where
425  editing and navigation is performed using the mouse, and {\bf cursor mode}
426  where editing and navigation are performed using the keyboard. The {\bf F2}
427  key is used to switch between these two modes. 
428  
429  {\em Note:} On MacBooks and other laptops with compact keyboards, you may need
430  to press the function key {\bf [Fn]} when pressing any of the numbered function
431  keys. So to toggle between keyboard and normal mode, press {\bf [Fn]-[F2]}.
432  
433
434 \begin{figure}[htb]
435 \begin{center}
436 \includegraphics[width=6.5in]{images/jalview_anatomy.pdf}
437 \caption{{\bf The anatomy of Jalview.} The major features of the Jalview Desktop
438 Application are labeled.}
439 % TODO: modify text labels to be clearer - black on grey and black border for clarity
440 \label{anatomy}
441 \end{center}
442 \end{figure}
443
444 \subsection{Navigation in Normal Mode}
445
446 Jalview always starts up in Normal mode, where the mouse is used to interact
447 with the displayed alignment view. You can move about the alignment by clicking
448 and dragging the ruler scroll bar to move horizontally, or by clicking and
449 dragging the alignment scroll bar to the right of the alignment to move
450 vertically.  If all the rows or columns in the alignment are displayed, the
451 scroll bars will not be visible.
452
453  Each alignment view shown in the alignment window presents a window onto the
454  visible regions of the alignment. This means that with anything more than a few
455  residues or sequences, alignments can become difficult to visualize on the
456  screen because only a small area can be shown at a time. Here, it helps, to
457  have an overview of the whole alignment, especially when it is large.
458  Select {\sl View $\Rightarrow$ Overview Window} from the Alignment
459  window menu bar (Figure \ref{overview}).
460 % (Figure4)
461 \begin{figure}[htbp]
462 \begin{center}
463 \includegraphics[width=4.5in]{images/overview.pdf}
464 \caption{{\bf Alignment Overview Window.} The overview window for a view is
465 opened from the {\em View} menu.}
466 \label{overview}
467 \end{center}
468 \end{figure}
469
470 The red box in the overview window shows the current view in the alignment
471 window. A percent identity histogram is plotted below the alignment overview.
472 Shaded parts indicate rows and columns of the alignment that are hidden (for more information see Section
473 \ref{hidingregions}). You can navigate around the alignment by dragging the red
474 box. 
475
476 %Try this now and see how the view in the alignment window changes.
477
478 \parbox[c]{3in}{Alignment and analysis windows are closed by clicking on the
479 usual `close' icon (indicated by arrows on Mac OS X). If you want to close all
480 the alignments and analysis windows at once, then use the {\sl Window
481 $\Rightarrow$ Close All} option from the Jalview desktop.
482
483 {\bf \em{Warning: Make sure you have saved your work because this cannot be
484 undone!}} }
485 \parbox[c]{3in}{\centerline{\includegraphics[width=2.5in]{images/start_closeall.pdf}
486 }}
487
488 \subsection{Navigation in Cursor Mode}
489 \label{cursormode}
490 \parbox[c]{5in}{Cursor mode navigation enables the user to quickly
491 and precisely navigate, select and edit parts of an alignment. On pressing F2 to
492 enter cursor mode the position of the cursor is indicated by a black background
493 and white text. The cursor can be placed using the mouse or moved by pressing
494 the arrow keys ($\uparrow$, $\downarrow$, $\leftarrow$, $\rightarrow$).
495 }\parbox[c]{1.25in}{\centerline{\includegraphics[width=0.8in]{images/cursor1.pdf}}}
496
497 Rapid movement to specific positions is accomplished as listed below:
498 \begin{list}{$\circ$}{}
499 \item {\bf Jump to Sequence {\sl n}:} Type a number {\sl n} then press [S] to
500 move to sequence (row) {\sl n}.
501 \item {\bf Jump to Column {\sl n}:} Type a number {\sl n} then press [C] to move to column {\sl n} in the alignment.  
502 \item {\bf Jump to Residue {\sl n}:} Type a number {\sl n} then press [P] to move to residue number {\sl n} in the current sequence.  
503 \item {\bf Jump to  column {\sl m} row {\sl n}:} Type the column number {\sl m}, a comma, the row number {\sl n} and press [RETURN]. 
504 \end{list}
505 \subsection{The Find Dialog Box}
506 \label{searchfunction}
507 A further option for navigation is to use the {\sl Select $\Rightarrow$
508 Find\ldots} function. This opens a dialog box into which can be entered regular
509 expressions for searching sequences and sequence IDs, or sequence numbers.
510 Hitting the [Find next] button will highlight the first (or next) occurrence of
511 that pattern in the sequence ID panel or the alignment, and will adjust the view
512 in order to display the highlighted region. The Jalview Help provides
513 comprehensive documentation for this function, and a quick guide to the regular
514 expressions that can be used with it.
515 %TODO insert a figure for the Find dialog box
516
517 \exercise{Navigation}{
518 \label{navigationEx}
519 Jalview has two navigation and editing modes: {\bf normal} mode (where editing
520 and navigation are via the mouse) and the {\bf cursor} mode (where editing and
521 navigation are via the keyboard).
522 The {\bf F2} key is used to switch between these two modes. With a Mac, the key
523 combination {\bf Fn and F2} keys are needed, as the {\bf F2} button is
524 often assigned to screen brightness. Jalview always starts up in normal mode.
525
526 \exstep{Load an example alignment from its URL
527 (\url{http://www.jalview.org/examples/exampleFile_2_7.jar}) via the Desktop
528 using {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ from URL} dialog
529 box.
530 (The URL should be stored in its history and clicking on the {\sl down arrow}
531 on the dialog box is an easy way to access it.)}
532 \exstep{Scroll around the alignment using the alignment (vertical) and ruler (horizontal) scroll bars.}
533 \exstep{Find the Overview Window, {\sl View
534 $\Rightarrow$ Overview Window} and open it. Move around the
535 alignment by clicking and dragging the red box in the overview window.}
536 \exstep{Return to the alignment window, look at the status bar (lower left
537 hand corner of the alignment window) as you move the mouse over the alignment. It indicates information about the
538 sequence and residue under the cursor.}
539 \exstep{Press [F2] key, or [Fn]-[F2] on Mac, to enter Cursor mode. Use
540 the direction keys to move the cursor around the alignment.}
541 \exstep{Move to sequence 7 by pressing {\bf 7 S}. Move to column 18 by pressing
542 {\bf 1 8 C}. Move to residue 18 by pressing {\bf 1 8 P}. Note that these can be
543 two different positions if gaps are inserted into the sequence. Move to sequence 5,
544 column 13 by typing {\bf 1 3 , 5} [RETURN].}
545
546 {\bf Note:} To view Jalview's comprehensive on-line help documentations select
547 {\sl Help} in desktop window menu, clicking on {\sl Documentation} will open a
548 Documentation window. Select topics from the navigation panel on the left hand
549 side or use the Search tab to locate specific key words.
550
551 {\sl\bf See the video at: 
552 \url{http://www.jalview.org/Help/Getting-Started}.}
553 }
554
555 \section{Loading Sequences and Alignments}
556 \label{loadingseqs}
557 %Jalview provides many ways to load your own sequences. %For this section of the
558 % tutorial you will need to download the file http://www.jalview.org/tutorial/alignment.fa to a suitable location on your hard drive.
559 \subsection{Drag and Drop}
560         In most operating systems you can drag a file icon from a file browser
561         window and drop it on an open Jalview application window. The file will then be opened as a new alignment window. 
562         %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.
563         Drag and drop also works when loading data from a URL -
564 simply drag the link or url from the address panel of your browser onto an
565 alignment or the Jalview desktop background and Jalview will load data from the
566 URL directly.
567 %  (Figure \ref{drag})
568 % %[fig 5]
569 % \begin{figure}[htbp]
570 % \begin{center}
571 % \includegraphics[width=2in]{images/drag2.pdf}
572 % \includegraphics[width=2in]{images/drag3.pdf}
573 % \caption{{\bf An alignment can be opened by dragging the file onto the Jalview window. }}
574 % \label{drag}
575 % \end{center}
576 % \end{figure}
577
578 % %\includegraphics[width=2in]{images/drag1.pdf}
579
580
581 \subsection{From a File}
582 Jalview can read sequence alignments from a sequence alignment file. This is a
583 text file, {\bf not} a word processor document. For entering sequences from a
584 wordprocessor document see Cut and Paste  (Section \ref{cutpaste}). Select
585 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the main
586 menu (Figure \ref{loadfile}). You will then get a file selection window where
587 you can choose the file to open. Remember to select the appropriate file type.
588 Jalview can automatically identify some sequence file formats.
589
590 %[fig 6]
591 \begin{figure}[htbp]
592 \begin{center}
593 \includegraphics[width=2in]{images/loadfilebox.pdf}
594 %\includegraphics[width=2in]{images/loadfilebox2.pdf}
595 \includegraphics[width=3in]{images/loadfileboxdrop.pdf}
596 \caption{{\bf Opening an alignment from a file saved on disk. }}
597 \label{loadfile}
598 \end{center}
599 \end{figure}
600
601 \subsection{From a URL}
602 Jalview can read sequence alignments directly from a URL. Please note that the
603 files must be in a sequence alignment format - an HTML alignment or graphics
604 file cannot be read by Jalview.
605 Select {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From URL} from the
606 main menu and a window will appear asking you to enter the URL (Figure
607 \ref{loadurl}). Jalview will attempt to automatically discover the file format.
608
609 %[fig 7]
610 \begin{figure}[htbp]
611 \begin{center}
612 \includegraphics[width=2in]{images/menuloadurl.pdf}
613 \includegraphics[width=3in]{images/loadurlbox.pdf}
614 \caption{{\bf Opening an alignment from a URL. }}
615 \label{loadurl}
616 \end{center}
617 \end{figure}
618
619 \subsection{Cut and Paste}
620 \label{cutpaste}
621 Documents such as those produced by Microsoft Word cannot be readily understood
622 by Jalview. The way to read sequences from these documents is to select the
623 data from the document and copy it to the clipboard. There are two ways to
624 do this. One is to right-click on the desktop background, and select the
625 `Paste to new window' option in the menu that appears. The other is to select
626 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox} from the
627 main menu, paste the sequences into the text window that will appear, and select
628 {\sl New Window} (Figure \ref{loadtext}). In both cases, presuming that they are
629 in the right format, Jalview will happily read them into a new alignment window.
630 %[fig 8]
631
632 \begin{figure}[htbp]
633 \begin{center}
634 \includegraphics[width=2in]{images/menuloadtext.pdf}
635 \includegraphics[width=3in]{images/loadtextbox.pdf}
636 \caption{{\bf Opening an alignment from pasted text. }}
637 \label{loadtext}
638 \end{center}
639 \end{figure}
640
641
642 \subsection{From a Public Database}
643 \label{fetchseq}
644 Jalview can retrieve sequences and sequence alignments from the public databases
645 housed at the European Bioinformatics Institute, including Uniprot, Pfam, Rfam
646 and the PDB. Jalview's sequence fetching capabilities allow you to avoid having to
647 manually locate and save sequences from a web page before loading them into
648 Jalview. It also allows Jalview to gather additional metadata provided by the
649 source, such as annotation and database cross-references.
650
651 To begin retrieving data, select {\sl File $\Rightarrow$ Fetch Sequences \ldots} 
652 from the main menu. A window will then appear (Figure \ref{loadseq}) showing all 
653 the database sources Jalview can access (grouped by the type of database). Once 
654 you've selected the appropriate database by double clicking it or hitting OK, the 
655 database selection window will close and the sequence fetcher for that database 
656 will appear. You can then enter one or several database IDs or accession numbers 
657 separated by a semicolon and press OK. Jalview will then attempt to retrieve them 
658 from the chosen database. Example queries are provided for some databases to test
659 that a source is operational, and can also be used as a guide for the type of 
660 accession numbers understood by the source.
661 % [fig 9]
662 \begin{figure}[htbp]
663 \begin{center}
664 \includegraphics[width=5in]{images/fetchseq.pdf}
665 \caption{{\bf Retrieving sequences from a public database.}}
666 \label{loadseq}
667 \end{center}
668 \end{figure}
669  
670
671 \exercise{Loading Sequences}{
672 \label{load}
673 \exstep{Use {\sl Window $\Rightarrow$ Close All} from the Desktop window menu to
674 close all windows.}
675 %% TODO: omit or combine this exercise
676 %% NB. Edge (MS default browser) doesn't actually allow you to 'save' the page, apparently
677 \exstep{{\bf Loading sequences from URL:} Selecting {\sl File $\Rightarrow$
678 Input Alignment $\Rightarrow$ From URL} from the Desktop and enter \url{http://www.jalview.org/tutorial/alignment.fa} in the box.
679 Click {\sl OK} to load the alignment.}
680
681 %%TODO: omit or combine
682 \exstep{{\bf Loading sequences from a file:} Close all windows using the
683 {\sl Window $\Rightarrow$ Close All} menu option from the Jalview desktop.
684 Then type the same URL (\url{http://www.jalview.org/tutorial/alignment.fa}) into
685 your web browser and save the fasta file (.fa) file to your desktop using {\sl File
686 $\Rightarrow$ Save Page as}.
687 Open the file you have just saved in Jalview by selecting {\sl File
688 $\Rightarrow$ Input Alignment $\Rightarrow$ From File} from the desktop menu.
689 Select the file and click {\sl OK} to load.}
690
691 \exstep{{\bf Loading sequences by `Drag and Drop' / `Cut and Paste':}
692
693 (i) Drag the alignment.fa file that you have just saved from its folder and
694 drop it onto the Jalview desktop window, the alignment should open.
695
696 (ii) Open
697 \url{http://www.jalview.org/examples/estrogenReceptorProtein.fa} in a web
698 browser. Test the differences
699 between (a) dragging the URL directly from browser onto the Jalview
700 desktop.
701 (If the URL is downloaded, alternatively locate the file in your download
702 directory and drag it onto the desktop.) (b) dragging the URL from
703 browser onto the existing alignment.fa alignment window in the Jalview desktop.
704
705 (iii) Open \url{http://www.jalview.org/examples/estrogenReceptorCdna.fa} in a web
706 browser. Note that this is a cDNA file. Drag the URL from
707 browser onto the estrogenReceptorProtein.fa protein alignment window in
708 the Jalview desktop. A dialogue box opens asking `Would you like to open as split
709 window, with cDNA and protein linked?' select `Split Window' option. A
710 split window opens in the Jalview desktop.
711 }
712
713 \exstep{{\bf The text editor:} 
714
715 (i) Open the alignment.fa file using text editor.
716 Copy the sequence text into the clipboard  using [CTRL]-A and then [CTRL]-C.
717
718 (ii) Move the mouse pointer onto the Jalview desktop window's background and right-click 
719 to open the context window. Select the {\sl Paste to New Window} menu option.
720
721 (iii) In the Jalview desktop menu, select {\sl File
722 $\Rightarrow$ Input Alignment $\Rightarrow$ From Textbox}.
723 Paste the clipboard into the large window using [CTRL]-V. Click {\sl New Window}
724 and the alignment will be loaded.}
725
726 \exstep{{\bf Loading sequences from Public Database:} (i) Select {\sl File
727 $\Rightarrow$ Fetch Sequences...} from the Jalview desktop menu. The {\sl
728 Select Database Retrieval Source} dialog will open listing all the database
729 sources. Select the {\bf PFAM seed} database and click {\sl OK}.
730
731 %TODO fix ss appearing as RNA ss issue with secondary structure from pfam when downloading the Full alignment.
732
733 (ii) The {\sl New
734 Sequence Fetcher} window will open. Enter the accession number {\bf PF03460}
735 and click {\sl OK}.
736 An alignment of about 174 sequences should load.}
737 \exstep{These can be viewed using the Overview window accessible from {\sl View
738 $\Rightarrow$ Overview Window.}}
739 {\bf See the video at:
740 \url{http://www.jalview.org/Help/Getting-Started}} }
741
742 \subsection{Memory Limits}
743 \label{memorylimits}
744 Jalview 2.11 and later will automatically maximise the amount of memory available,
745 but if you are using an earlier version or launching Jalview in a specialised way
746 you may need ensure that you have allocated enough memory to
747 work with your data. On most occasions, Jalview will warn you when you have
748 tried to load an alignment that is too big to fit in to memory (for instance,
749 some of the PFAM alignments are {\bf very} large). You can find out how much
750 memory is available to Jalview with the desktop window's {\sl $\Rightarrow$
751 Tools $\Rightarrow$ Show Memory Usage} function, which enables the display of
752 the currently available memory at the bottom left hand side of the Desktop
753 window's background. Should you need to increase the amount of memory available
754 to Jalview, full instructions are given in the built in documentation (opened by
755 selecting {\sl Help $\Rightarrow$ Documentation}) and on the JVM memory
756 parameters page (\url{http://www.jalview.org/jvmmemoryparams.html}).
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, select file type 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 desktop window 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 To select multiple complete sequences, click and drag the mouse down the
894 sequence ID panel. The same techniques can be used as for columns above ([SHIFT]-Click for continuous and [CTRL]-Click (or {\sl 
895 [CMD]-Click} for Mac) to select discontinuous
896 ranges of sequences (Figure \ref{selectrows}).
897 %[fig 14]
898
899 \subsection{Selecting Sequences}
900
901 \begin{figure}[htb]
902 \begin{center}
903 \includegraphics[width=4in]{images/select3.pdf}
904 \caption{{\bf Selecting multiple sequences in an alignment.} Use [CTRL] or
905 [SHIFT] to select many sequences at once.}
906 \label{selectrows}
907 \end{center}
908 \end{figure}
909
910
911
912 \subsection{Making Selections in Cursor Mode}
913
914 To define a selection in cursor mode (which is enabled by pressing [F2] when the alignment window is selected),
915 navigate to the top left corner of the proposed selection (using the mouse, the arrow keys, or the keystroke
916 commands described in Section \ref{cursormode}). Pressing the [Q] key marks this as the
917 corner. A red outline appears around the cursor (Figure \ref{cselect}).
918
919 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.
920
921 \begin{figure}[htbp]
922 \begin{center}
923 \includegraphics[width=1.5in]{images/csel1.pdf}
924 \includegraphics[width=1.5in]{images/csel2.pdf}
925 \includegraphics[width=1.5in]{images/csel3.pdf}
926 \includegraphics[width=1.5in]{images/csel4.pdf}
927 \caption{{\bf Making a selection in cursor mode.} Navigate to the top left
928 corner (left), press [Q], navigate to the bottom right corner and press [M] (right).}
929 \label{cselect}
930 \end{center}
931 \end{figure}
932
933 \begin{figure}
934 \begin{center}
935 \includegraphics[width=3in]{images/group1.pdf}
936 \includegraphics[width=1.5in]{images/newgroup.pdf}
937 \caption{{\bf Creating a new group from a selection.}}
938 \label{makegroup}
939 \end{center}
940 \end{figure}
941
942 \subsection{Inverting the Current Selection}
943 The current sequence or column selection can be inverted, using  {\sl Select
944 $\Rightarrow$ Invert Sequence/Column Selection} in the alignment window.
945 Inverting the selection is useful when selecting large regions in an alignment, 
946 simply select the region that is to be kept unselected, and then invert the selection.
947 This may also be useful when hiding large regions in an alignment (see Section \ref{hidingregions}).
948 Instead of selecting the columns and rows that are to be hidden, simply select the 
949 region that is to be kept
950 visible, invert the selection, then select {\sl View $\Rightarrow$ Hide
951 $\Rightarrow$ Selected Region}.
952
953 \section{Creating Groups}
954 Selections are lost as soon as a different region is selected. Groups can be
955 created which are labeled regions of the alignment. To create a group, first
956 select the region which is to comprise the group. Then click the right mouse
957 button on the selection to bring up a context menu. Select {\sl Selection
958 $\Rightarrow$ Edit New Group $\Rightarrow$ Edit name and description of
959 current group}\footnote{In earlier versions of Jalview, this entry was variously
960 `Group', `Edit Group Name', or `JGroupXXXXX' (Where XXXXX was some serial
961 number).} then enter a name for the group in the dialog box which appears.
962
963 By default the new group will have a box drawn around it. The appearance of the group can be changed (see Section \ref{colours}). 
964 This group will stay defined even when the selection is removed.
965
966
967 \section{Exporting the Current Selection}
968 The current selection can be copied to the clipboard (in PFAM format). It can
969 also be output to a textbox using the output functions in the pop-up menu
970 obtained by right clicking the current selection. The textbox enables quick
971 manual editing of the alignment prior to importing it into a new window (using
972 the {\sl New Window} button) or saving to a file with the {\sl File
973 $\Rightarrow$ Save as } pulldown menu option from the text box.
974
975 \exercise{Making Selections and Groups}{
976 \label{exselect}
977 \exstep{Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
978 }
979 \exstep{Selecting an arbitrary region. Choose a residue and place the mouse
980 cursor on it (residue information will show in alignment window status
981 bar).
982 Click and drag the mouse to the bottom-right to create a selection. As you drag,
983 a red box will `rubber band' out to 
984 show the extent of the selection.
985 Release the mouse
986 button and a red box borders the selected region.
987 Press [ESC] to clear this.}
988 \exstep{ Select one sequence by clicking on
989 the sequence ID panel. Note that the sequence ID takes on a highlighted
990 background and a red box appears around the selected sequence. 
991 Hold down [SHIFT] and click another sequence ID a few positions above or below. 
992 Note how the selection expands to include all the sequences between the two positions on which you clicked.
993 Hold down [CTRL] (or [CMD] on Mac) and then click on several sequences' IDs - both selected and
994 unselected. Note how unselected IDs are individually added to the selection and previously selected IDs are 
995 individually deselected.}
996 \exstep{ Select columns by clicking on the Alignment Ruler. Note
997 that the selected column is marked with a red box.
998 Hold down [SHIFT] and click a column beyond. Note the selection expands to
999 include all the sequences between the two positions on which you clicked.}
1000
1001 \exstep{Enter Cursor mode using [F2], or [Fn]-F2 for Macs.
1002 Navigate to column 59, row 1 by pressing {\bf 5 9 , 1 [RETURN]}.
1003 Press {\bf Q} to mark this position.
1004 Navigate to column 65, row 8 by pressing {\bf 6 5 , 8 [RETURN]}. Press {\bf M}
1005 to complete the selection. Note to clear the selection press the [ESC]
1006 key.}
1007 \exstep{To create a group from the selected the region, click the
1008 right mouse button when mouse is on the selection, this opens a
1009 context menu in the alignment window.
1010
1011 Open the {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
1012 } menu and select {\sl Percentage Identity}.
1013 This will turn the selected region into a group and colour it accordingly.}
1014 \exstep{Hold down [CTRL] and use the mouse to select and deselect sequences in
1015 the alignment by clicking on their Sequence ID label. Note how the group expands
1016 to include newly selected sequences, and the Percentage Identity colouring changes. }
1017 \exstep{ Another way to resize the group is by using the mouse to click and drag
1018 the right-hand edge of the selected group.}
1019
1020 \exstep{The current selection can be exported and saved, place mouse on the text
1021 area and right clicking the mouse to open the Sequence ID context menu.
1022 Select appropriate menu option and pick an output format (eg BLC) from the
1023 {\sl Selection $\Rightarrow$ Output to Textbox \ldots} submenu.
1024 }
1025 \exstep{In the Alignment output window that opens, try manually editing the
1026 alignment before clicking the {\sl New Window} button. This opens the
1027 edited alignment in a new alignment window.} {\bf See the video at:
1028 \url{http://www.jalview.org/training/Training-Videos}.}
1029 % more? change colouring style. set border colour.
1030 }
1031
1032
1033 \section{Reordering an Alignment}
1034 Sequence reordering is simple. Highlight the sequences to be moved then press the up or down arrow keys ($\uparrow$, $\downarrow$) as appropriate (Figure \ref{reorder}). 
1035 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 
1036 then move the group rather than the individual sequence.
1037
1038 \begin{figure}[htbp]
1039 \begin{center}
1040 \includegraphics[width=3in]{images/move1.pdf}
1041 \includegraphics[width=3in]{images/move2.pdf}
1042 \caption{{\bf Reordering the alignment.} The selected sequence moves up one
1043 position on pressing the $\uparrow$ key.}
1044 \label{reorder}
1045 \end{center}
1046 \end{figure}
1047
1048 \exercise{Reordering the Alignment}{
1049 \label{reorderex}
1050 \exstep{Close windows.
1051
1052 Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
1053 }
1054 \exstep{Select one of the sequence in the sequence ID panel, use the up and down
1055 arrow keys to alter the sequence's position in the alignment. (Note that
1056 this will not work in cursor mode)}
1057 \exstep{To select and move multiple
1058 sequences, use hold [SHIFT], and select two sequences separated by
1059 one or more un-selected sequences, repeat using the [CTRL] key. Note how
1060 multiple sequences are grouped together when they are re-ordered using the up and down arrow keys.}
1061 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}
1062 }
1063
1064
1065 \section{Hiding Regions}
1066 \label{hidingregions}
1067 It is sometimes convenient to exclude some sequences or residues in the alignment without actually deleting them. 
1068 Jalview allows sequences or alignment columns within a view to be hidden, and this facility has been used to create 
1069 the several different views in the example alignment file that is loaded when Jalview is first started (see Figure \ref{startpage}).
1070
1071 To hide a set of sequences, select them and right-click the mouse on the
1072 selected sequence IDs to bring up the context pop-up menu. Select {\sl Hide
1073 Sequences} and the sequences will be concealed, with a small blue triangle indicating their position (Figure \ref{hideseq}). 
1074 To unhide (reveal) the sequences, right click on the triangle and select {\sl Reveal Sequences} from the context menu.
1075
1076
1077  \begin{figure}[htbp]
1078 \begin{center}
1079 \includegraphics[width=1.9in]{images/hide1.pdf}
1080 \includegraphics[width=2.7in]{images/hide2.pdf}
1081 \includegraphics[width=1.8in]{images/hide3.pdf}
1082 \caption{{\bf Hiding Sequences} Hidden sequences are represented by a small
1083 blue triangle in the sequence ID panel.}
1084 \label{hideseq}
1085 \end{center}
1086 \end{figure}
1087
1088 A similar mechanism applies to columns (Figure \ref{hidecol}). Selected columns
1089 (indicated by a red marker) can be hidden and revealed in the same way {\sl via}
1090 the context pop-up menu by right clicking on the ruler bar. The hidden column
1091 selection is indicated by a small blue triangle in the ruler bar.
1092
1093  \begin{figure}[htbp]
1094 \begin{center}
1095 \includegraphics[width=1.7in]{images/hide4.pdf}
1096 \includegraphics[width=3in]{images/hide5.pdf}
1097 \includegraphics[width=1.2in]{images/hide6.pdf}
1098 \caption{{\bf Hiding Columns} Hidden columns are represented by a small blue
1099 triangle in the ruler bar.}
1100 \label{hidecol}
1101 \end{center}
1102 \end{figure}
1103
1104 It is often easier to select the region that you intend to work with, rather
1105 than the regions that you want to hide. In this case, select the required region and use the {\sl View $\Rightarrow$ Hide
1106 $\Rightarrow$ All but Selected Region } menu entry, or press [SHIFT]-[CTRL]-H
1107 to hide the unselected region.
1108
1109 \subsection{Representing a Group with a Single Sequence}
1110
1111 Instead of hiding a group completely, it is sometimes useful to work with just one representative sequence. 
1112 The {\sl $<$Sequence ID$>$ $\Rightarrow$ Represent group with $<$Sequence ID$>$ } option from the sequence ID pop-up menu enables this variant 
1113 of the hidden groups function. The remaining representative sequence can be visualized and manipulated like any other. 
1114 Note, any alignment edits that affect the sequence will also affect the whole
1115 sequence group.
1116
1117
1118 \begin{figure}[htb]
1119 \begin{center}
1120 \includegraphics[width=3in]{images/edit1.pdf}
1121 \includegraphics[width=3in]{images/edit2.pdf}
1122 \caption{{\bf Introducing gaps in a single sequence.} Gaps are introduced as the
1123 selected sequence is dragged to the right while pressing and holding [SHIFT].}
1124 \label{gapseq}
1125 \end{center}
1126 \end{figure}
1127
1128 \begin{figure}[htb]
1129 \begin{center}
1130 \includegraphics[width=3in]{images/edit3.pdf}
1131 \includegraphics[width=3in]{images/edit4.pdf}
1132 \caption{{\bf Introducing gaps in a group.} Gaps are introduced as the selected
1133 group is dragged to the right with [CTRL] pressed.}
1134 \label{gapgroup}
1135 \end{center}
1136 \end{figure}
1137
1138 %% TODO introduce select/hide by annotation here
1139 %% favor coverage of these core interactions (hide, show, select, reorder, multiple view)
1140 %% TODO - if columns are selected, then View->hide selected region hides *all* sequences, but it should leave the unselected columns visible !
1141
1142 \exercise{Hiding and Revealing Regions}{
1143 \label{hidingex}
1144 \exstep{Load the ferredoxin alignment ({\bf PF03460} from {\bf PFAM (seed)}).
1145 }
1146 \exstep{Select a contiguous set of sequences by clicking and dragging on the sequence ID panel.
1147 Right click on the selected sequence IDs to bring up the sequence ID context
1148 menu, select {\sl Hide Sequences}.
1149 }
1150 \exstep{
1151 Right click on the blue triangle indicating hidden sequences and select {\sl
1152 Reveal Sequences} in the panel. (If you have hidden all sequences then you will
1153 need to use the alignment window menu option {\sl View $\Rightarrow$ Show $\Rightarrow$ 
1154 All Sequences.}) }
1155 \exstep{
1156 Repeat the process but use a non-contiguous set of sequences. Note that when
1157 multiple regions are hidden you can select either {\sl
1158 Reveal Sequences} to reveal the hidden sequences that were clicked, or {\sl
1159 Reveal All}.
1160 }
1161 \exstep{Repeat the above using columns to hide and reveal columns
1162 instead of sequences.}
1163 \exstep{Select a region of the alignment, and experiment with the {\sl Hide all
1164 but selected region} option in {\sl View $\Rightarrow$ Hide $\Rightarrow$ All
1165 but selected region.}} \exstep{Select some sequences, pick one to represent the rest by hovering
1166 the mouse over this sequence. Bring up the Sequence ID context menu by right
1167 clicking and select {\sl (Sequence ID name) $\Rightarrow$ Represent group
1168 with (Sequence ID name )}. To reveal these hidden sequences, right click on the
1169 Sequence ID and in the context menu select {\sl Reveal All}.}
1170 {\bf See the video at:  \url{http://www.jalview.org/training/Training-Videos}.}
1171 }
1172
1173
1174
1175 \section{Introducing and Removing Gaps}
1176 The alignment view provides an interactive editing interface, allowing gaps to be inserted or deleted to the left of any position
1177 in a sequence or sequence group. Alignment editing can only be performed whilst in keyboard editing mode (entered by pressing [F2])
1178  or by clicking and dragging residues with the mouse when [SHIFT], [CTRL] or [CMD] (Mac) is held down (which differs from earlier versions of Jalview).
1179
1180
1181 \subsection{Undoing Edits}
1182 Alignment edits can be undone {\sl via} the {\sl Edit $\Rightarrow$ Undo Edit}
1183 alignment window menu option, or [CTRL]-Z. An edit, if undone, may be re-applied
1184 with {\sl Edit $\Rightarrow$ Redo Edit}, or [CTRL]-Y. Note, however, that the
1185 {\sl Undo} function only works for edits to the alignment or sequence ordering.
1186 Colouring of the alignment, showing and hiding of sequences or modification of
1187 annotation that only affect the alignment's display cannot
1188 be undone.
1189
1190 \subsection{Locked Editing}
1191 \label{lockededits}
1192 The Jalview alignment editing model is different to that used in other alignment
1193 editors. Because edits are restricted to the insertion and deletion of gaps to the left of a particular sequence position, 
1194 editing has the effect of shifting the rest of the sequence(s) being edited down or up-stream with respect to the rest of 
1195 alignment. The {\sl Edit $\Rightarrow$ Pad Gaps} option can be enabled to eliminate `ragged edges' at the end of the alignment, 
1196 but does not avoid the `knock-on' effect which is sometimes undesirable. 
1197 However, its effect can be limited by performing the edit within a selected region. 
1198 In this case, gaps will only be removed or inserted within the selected region. 
1199 Edits are similarly constrained when they occur adjacent to a hidden column.
1200
1201 \subsection{Introducing Gaps in a Single Sequence}
1202 To introduce a gap, first select the sequence in the sequence ID panel and
1203 then place the cursor on the residue to the immediate right of where the gap
1204 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 
1205 has been inserted.
1206
1207 One common error is to forget to hold down [SHIFT]. This results in a selection which is one sequence high and one residue long. 
1208 Gaps cannot be inserted in such a selection. The selection can be cleared and editing enabled by pressing the [ESC] key.
1209
1210 \subsection{Introducing Gaps in all Sequences of a Group}
1211 To insert gaps in all sequences in a selection or group, select the
1212 required sequences in the sequence ID panel and then place the mouse cursor on
1213 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 
1214 and the left mouse button, then drag the sequences to the right until the required number of gaps has appeared.
1215
1216 Gaps can be removed by dragging the residue to the immediate right of the gap
1217 leftwards whilst holding down [SHIFT] (for single sequences) or [CTRL] (for a group of sequences).
1218
1219 \subsection{Sliding Sequences}
1220 Pressing the [$\leftarrow$] or [$\rightarrow$] arrow keys when one or more
1221 sequences are selected will ``slide'' the entire selected sequences to the left
1222 or right (respectively). Slides occur regardless of the region selection -
1223 which, for example, allows you to easily reposition misaligned subfamilies
1224 within a larger alignment.
1225 % % better idea to introduce hiding sequences, and use the invert selection, hide
1226 % others, to simplify manual alignment construction
1227
1228
1229
1230 \subsection{Editing in Cursor Mode}
1231 Gaps can be easily inserted when in cursor mode (toggled with [F2]) by
1232 pressing [SPACE]. Gaps will be inserted at the cursor, shifting the residue
1233 under the cursor to the right. To insert {\sl n} gaps type {\sl n} and then
1234 press [SPACE]. To insert gaps into all sequences of a group, use [CTRL]-[SPACE]
1235 or [SHIFT]-[SPACE] (both keys held down together).
1236
1237 Gaps can be removed in cursor mode by pressing [BACKSPACE]. First make sure you
1238 have everything unselected by pressing [ESC]. The gap under the cursor will be
1239 removed. To remove {\sl n} gaps, type {\sl n} and then press [BACKSPACE]. Gaps
1240 will be deleted up to the number specified. To delete gaps from all sequences of
1241 a group, press [CTRL]-[BACKSPACE] or [SHIFT]-[BACKSPACE] (both keys held down
1242 together). Note that the deletion will only occur if the gaps are in the same
1243 columns in all sequences in the selected group, and those columns are to the
1244 right of the selected residue.
1245
1246
1247 \exercise{Editing Alignments}
1248   %\label{mousealedit}
1249 % TODO: VERIFY FOR 2.6.1 and 2.7 - NUMBERING/INSTRUCTIONS APPEAR OFF
1250 {
1251 \label{editingalignex}
1252 You are going to manually reconstruct part of the example Jalview
1253 alignment available at
1254  \href{http://www.jalview.org/examples/exampleFile.jvp}
1255  {http://www.jalview.org/examples/exampleFile.jvp}.
1256
1257 {\sl {\bf Mac Users:} Please use the Apple or [CMD] key in place of [CTRL]
1258 for key combinations such as [CTRL]-A. }
1259
1260 Remember to use [CTRL]-Z to undo an edit, or the {\sl File $\Rightarrow$
1261  Reload } function to revert the alignment back to the original version if you
1262  want to start again.
1263
1264 \exstep{ Load the URL
1265 \textsf{http://www.jalview.org/tutorial/unaligned.fa} which contains part of the
1266 ferredoxin alignment from PF03460.}
1267
1268 \exstep{ Select the first 7 sequences, and press H key to hide them (or right click
1269 on the sequence IDs to open the sequence ID context menu, and select {\sl Hide
1270 Sequences}).}
1271
1272 \exstep{ Select FER3\_RAPSA and FER\_BRANA. Slide the sequences to
1273 the right so the initial residue A lies at column 57 using the $\rightarrow$
1274 key.}
1275
1276 \exstep{ Select FER1\_SPIOL, FER1\_ARATH, FER2\_ARATH, Q93Z60\_ARATH and
1277 O80429\_MAIZE
1278
1279 {\sl Hint: you can do this by pressing [CTRL]-I to invert the sequence selection and then
1280 deselect FER1\_MAIZE), and use the $\rightarrow$ key to slide them to so they
1281 begin at column 5 of the alignment view.}} 
1282
1283 \exstep{ Select all the visible
1284 sequences (those not hidden) in the block by pressing [CTRL]-A.
1285 Insert a single
1286 gap in all selected sequences at column 38 of the alignment by holding [CTRL]
1287 and clicking on the residue R at column 38 in the FER1\_SPIOL, then drag one
1288 column to right.
1289 Insert another gap at column 47 in all sequences in the same way.}
1290
1291 \exstep{ Correct the ferredoxin domain alignment for FER1\_SPIOL by
1292 inserting two additional gaps after the gap at column 47. First press [ESC] to
1293 clear the selection, then hold [SHIFT] and click and drag on the G and move it
1294 two columns to the right.}
1295
1296 \exstep{ Now complete the
1297 alignment of FER1\_SPIOL with a locked edit by pressing [ESC] and select
1298 columns 47 to 57 of the FER1\_SPIOL row. Move the mouse onto the G at column 50,
1299 hold [SHIFT] and drag the G in column 47 of FER1\_SPIOL to the left by one
1300 column to insert a gap at column 57.}
1301
1302 \exstep{ In the next two steps you will complete the alignment of the last two 
1303 sequences.
1304
1305 Select the last two sequences (FER1\_MAIZE and O80429\_MAIZE), then press [SHIFT]
1306 and click and drag the initial methionine of O80429\_MAIZE 5 columns to the right
1307 so it lies at column 10.
1308
1309 Keep holding [SHIFT] and click and drag to insert
1310 another gap at the proline at column 25 (25C in cursor mode). Remove the gap at
1311 column 44, and insert 4 gaps at column 47 (after AAPM).}
1312
1313 \exstep{ Hold [SHIFT] and drag the I at column 39 of FER1\_MAIZE 2 columns to the
1314 right. Remove the gap at FER1\_MAIZE column 49 by [SHIFT]-click and drag left by
1315 one column. Press [ESC] to clear the selection, and then insert three gaps in
1316 FER1\_MAIZE at column 47 by holding [SHIFT] and click and drag the S in FER1\_MAIZE to the right by three columns. Finally,
1317 remove the gap in O80429\_MAIZE at column 56 using [SHIFT]-drag to the left on
1318 56C.}
1319
1320 \exstep{ Use the
1321 {\sl Edit $\Rightarrow$ Undo Edit} and {\sl Edit $\Rightarrow$ Redo Edit} menu
1322 option, or their keyboard shortcuts ([CTRL]-Z and [CTRL]-Y) to step 
1323 backwards and replay the edits you have made.}
1324 }
1325
1326
1327 \exercise{Keyboard Edits}
1328 {
1329 \label{keyboardsex}
1330 This continues on from the previous exercise, and recreates the final part of the example ferredoxin
1331 alignment from the unaligned sequences using Jalview's keyboard editing mode.
1332
1333 {\bf Window users:} Please {\em only use} [SHIFT]-[SPACE] in this
1334 exercise.
1335
1336 {\bf Mac users:} [CTRL]-[SPACE] can also be used instead of [SHIFT]-[SPACE].
1337
1338 \exstep{Load the sequence alignment at
1339 \textsf{http://www.jalview.org/tutorial/unaligned.fa}, or continue using the
1340 edited alignment.  If you continue from the
1341 previous exercise, first right click on the sequence ID panel and select
1342 {\sl Reveal All}. Enter cursor mode by pressing [F2] (or [Fn]-[F2] (Mac)).}
1343 % TODO: BACKSPACE or DELETE WHEN SEQS ARE SELECTED WILL DELETE ALL SEQS JAL-783
1344
1345 \exstep{Insert 58 gaps at the start of the sequence 1 (FER\_CAPAA). Press
1346 {\sl 58} then {\sl [SPACE]}. }
1347
1348 \exstep{Go down one sequence and select rows 2-5 as a block. Click on the second sequence ID (FER\_CAPAN).
1349  Hold down shift and click on the fifth (FER1\_PEA). }
1350
1351 \exstep{Insert 6 gaps at the start of this group. Go to column 1 row 2 by typing
1352 {\sl 1,2} then press {\sl [RETURN]}. Now insert 6 gaps in all the sequences.
1353 Type {\sl 6} then hold down {\sl [SHIFT]} and press {\sl [SPACE]}.}
1354 \exstep{Now insert one gap at column 34 and another at 38. Insert 3 gaps at 47.
1355 Press {\sl 34C} then {\sl [SHIFT]-[SPACE]}.  Press {\sl 38C} then
1356 [SHIFT]-[SPACE].
1357 Press {\sl 47C} then {\sl 3 [SHIFT-SPACE]} the first through fourth sequences
1358 are now aligned.}
1359 \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]} .}
1360 \exstep{ Similarly delete the gap now at column 34, then insert two gaps at
1361 column 38.
1362 Press {\sl 34C [BACKSPACE]  38C 2 [SPACE]}. Delete three gaps at column 44 and
1363 insert one at column 47 by pressing {\sl 44C 3 [BACKSPACE] 47C [SPACE]}.  The top five sequences are 
1364 now aligned.}}
1365
1366
1367 \chapter{Colouring Sequences and Figure Generation}
1368 \label{colouringfigures}
1369 \section{Colouring Sequences}
1370 \label{colours}
1371
1372 Colouring sequences is a key aspect of alignment presentation. Jalview allows
1373 you to colour the whole alignment, or just specific groups. Alignment and
1374 group colours are rendered
1375 {\bf below} any other colours, such as those arising from sequence features
1376 (these are described in Section \ref{featannot}). This means that if you
1377 try to apply one of the colourschemes described in this section, and nothing
1378 appears to happen, it may be that you have sequence feature annotation
1379 displayed, and you may have to disable it using the {\sl View $\Rightarrow$
1380 Show Sequence Features} option before you can see your colourscheme.
1381
1382 There are two main types of colouring styles: {\bf simple static residue}
1383 colourschemes and {\bf dynamic schemes} which use conservation and consensus
1384 analysis to control colouring. {\bf Hybrid colouring} is also possible, where
1385 static residue schemes are modified using a dynamic scheme. The individual schemes are described in Section \ref{colscheme}.
1386
1387 \subsection{Colouring the Whole Alignment}
1388
1389 \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. 
1390
1391 }\parbox[c]{3in}{
1392 \centerline {
1393 \includegraphics[width=2.5in]{images/colour2.pdf}
1394 }
1395 }
1396
1397 \subsection{Colouring a Group or Selection}
1398
1399 Selections or groups can be coloured in two ways. The first is {\sl via} the Alignment Window's {\sl Colour} menu as stated above,
1400  after first ensuring that the {\sl Apply Colour To All Groups} flag is {\bf
1401  not} selected.
1402  This must be turned {\bf off} specifically as it is {\bf on} by default. 
1403  When unticked, selections from the Colours menu will only change the colour for residues in the current selection, 
1404  or the alignment view's ``background colourscheme'' when no selection exists.
1405
1406 The second method is to select sequences and right click mouse to open pop-up
1407 menu and select {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group
1408 Colour} from context menu options
1409 (Figure \ref{colgrp}). This only changes the colour of the current selection or group.
1410
1411 \begin{figure}[htbp]
1412 \begin{center}
1413 %TODO update group_col.pdf to show latest jalview group edit submenu
1414 \includegraphics[width=4in]{images/group_col.pdf}
1415 \caption{{\bf Colouring a group via the context menu.}}
1416 \label{colgrp}
1417 \end{center}
1418 \end{figure}
1419
1420 \subsection{Shading by Conservation}
1421 For many colour schemes, the intensity of the colour in a column can be scaled
1422 by the degree of amino acid property conservation. Selecting {\sl Colour
1423 $\Rightarrow$ By Conservation} enables this mode, and {\sl Modify
1424 Conservation Threshold...} brings up a selection box (the {\sl Conservation
1425 Colour Increment} dialog box) allowing the alignment colouring to be modified.
1426 Selecting a higher value limits colouring to more highly conserved columns (Figure \ref{colcons}).
1427
1428  \begin{figure}[htbp]
1429 \begin{center}
1430 \includegraphics[width=2in]{images/colourcons1.pdf}
1431 \includegraphics[width=2in]{images/colourcons3.pdf}
1432 \includegraphics[width=2in]{images/colourcons5.pdf}
1433 \caption{{\bf Conservation Shading} The density of the ClustalX style residue
1434 colouring is controlled by the conservation threshold. The effect of 0\% (left), 50\% (center) and 100\% (right) thresholds are shown.
1435 }
1436 \label{colcons}
1437 \end{center}
1438 \end{figure}
1439
1440 \subsection{Thresholding by Percentage Identity}
1441
1442 `Thresholding' is another hybrid colour model where a residue is only coloured
1443 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).
1444
1445 \subsection{Colouring by Annotation}
1446 \label{colourbyannotation}
1447 \parbox[c]{3.2in}{
1448 Any of the {\bf quantitative} annotations shown on an alignment can be used to
1449 threshold or shade the whole alignment.\footnote{Please remember to turn off
1450 Sequence Feature display to see the shading} 
1451
1452 The {\sl Colour $\Rightarrow$ By
1453 Annotation} option opens a dialog which allows you to select which annotation
1454 to use, the minimum and maximum shading colours or whether the original
1455 colouring should be thresholded (the `Use original colours' option).
1456
1457 Default settings for minimum and maximum colours can be set in the Jalview
1458 Desktop's preferences.  
1459 }\parbox[c]{3in}{
1460 \centerline{\includegraphics[width=2.8in]{images/col_byannot.pdf}}}
1461
1462 The {\bf per Sequence} option in the {\bf Colour By Annotation} dialog
1463 allows each sequence to be shaded according to sequence associated annotation
1464 rows, such as protein disorder scores. This functionality is described further
1465 in Section \ref{protdisorderpred}.
1466
1467 \subsection{Colour Schemes} 
1468
1469 \label{colscheme}
1470 Full details on each colour scheme can be found in the Jalview on-line help. A brief description of each one is provided below:
1471
1472 \subsubsection{Clustalx}
1473
1474
1475  \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. }
1476 \parbox[c]{3in}{\includegraphics[width=2.75in]{images/col_clustalx.pdf}}
1477
1478 \subsubsection{Blosum62 Score}
1479
1480 \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.}
1481 \parbox[c]{3in}{
1482 \includegraphics[width=2.75in]{images/col_blosum62.pdf}
1483 }
1484
1485 \subsubsection{Percentage Identity}
1486 \parbox[c]{3.5in}{
1487 The Percentage 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.
1488 }
1489 \parbox[c]{3in}{
1490 \includegraphics[width=2.75in]{images/col_percent.pdf}
1491 }
1492
1493 \subsubsection{Zappo}
1494 \parbox[c]{3.5in}{
1495 The residues are coloured according to their physicochemical properties. The physicochemical groupings are Aliphatic/hydrophobic, Aromatic, 
1496 Positive, Negative, Hydrophillic, Conformationally special, and Cyst(e)ine.
1497 }
1498 \parbox[c]{3in}{
1499 \includegraphics[width=2.75in]{images/col_zappo.pdf}
1500 }
1501
1502 \subsubsection{Taylor}
1503
1504 \parbox[c]{3.5in}{
1505 This colour scheme was devised by Willie Taylor and an entertaining description of its origin can be found in Protein Engineering, 
1506 Vol 10 , 743-746 (1997).
1507 }
1508 \parbox[c]{3in}{
1509 \includegraphics[width=2.75in]{images/col_taylor.pdf}
1510 }
1511
1512 \subsubsection{Hydrophobicity}
1513 \parbox[c]{3.5in}{
1514 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.
1515 }
1516 \parbox[c]{3in}{
1517 \includegraphics[width=2.75in]{images/col_hydro.pdf}
1518 }
1519
1520 \subsubsection{Helix Propensity}
1521
1522 \parbox[c]{3.5in}{
1523 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.
1524 }
1525 \parbox[c]{3in}{
1526 \includegraphics[width=2.75in]{images/col_helix.pdf}
1527 }
1528
1529 \subsubsection{Strand Propensity}
1530
1531 \parbox[c]{3.5in}{
1532 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} Strand propensity. The highest propensity is Yellow, the lowest is blue.
1533 }
1534 \parbox[c]{3in}{
1535 \includegraphics[width=2.75in]{images/col_strand.pdf}
1536 }
1537
1538
1539
1540 \subsubsection{Turn Propensity}
1541 \parbox[c]{3.5in}{
1542 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} turn propensity. The highest propensity is red, the lowest is cyan.
1543 }
1544 \parbox[c]{3in}{
1545 \includegraphics[width=2.75in]{images/col_turn.pdf}
1546 }
1547
1548 \subsubsection{Buried Index}
1549 \parbox[c]{3.5in}{
1550 The residues are coloured according to their Chou-Fasman\textsuperscript{\ref{chou-fasman}} burial propensity. The highest propensity is blue, the lowest is green.
1551 }
1552 \parbox[c]{3in}{
1553 \includegraphics[width=2.75in]{images/col_buried.pdf}
1554 }
1555  
1556
1557 \subsubsection{Nucleotide}
1558 \parbox[c]{3.5in}{ Residues are coloured with four colours corresponding to the
1559 four nucleotide bases. All non ACTG residues are uncoloured. See Section
1560 \ref{workingwithnuc} for further information about working with nucleic acid
1561 sequences and alignments.
1562 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_nuc.pdf} }
1563
1564 \subsubsection{Purine/Pyrimidine}
1565 \parbox[c]{3.5in}{ Residues are coloured according to whether the corresponding
1566 nucleotide bases are purine (magenta) or pyrimidine (cyan) based. All non ACTG
1567 residues are uncoloured. For further information about working with nucleic acid
1568 sequences and alignments, see Section \ref{workingwithnuc}.
1569 %and Section \ref{workingwithrna}
1570
1571 } \parbox[c]{3in}{ \includegraphics[width=2.75in]{images/col_purpyr.pdf} }
1572
1573 \subsubsection{By RNA Helices}
1574 \parbox[c]{3.5in}{ Columns are coloured according to their assigned RNA helix as
1575 defined by a secondary structure annotation line on the alignment. Colours for
1576 each helix are randomly assigned, and option only available when an RNA
1577 secondary structure row is present on the alignment. 
1578 % For more details see Section \ref{workingwithrna} 
1579 } \parbox[c]{3in}{
1580 \includegraphics[width=2.75in]{images/col_rnahelix.pdf} }
1581
1582 \subsubsection{User Defined}
1583 This dialog allows the user to create any number of named colour schemes at
1584 will. Any residue may be assigned any colour. The colour scheme can then be
1585 named. If you save the colour scheme, this name will appear on the Colour menu
1586 (Figure \ref{usercol}).
1587
1588
1589 \begin{figure}[htbp]
1590 \begin{center}
1591 \includegraphics[width=2.1in]{images/col_user1.pdf}
1592 \includegraphics[width=2in]{images/col_user2.pdf}
1593 \includegraphics[width=2.1in]{images/col_user3.pdf}
1594 \caption{{\bf Creation of a user defined colour scheme.} Residue types are
1595 assigned colours (left). The profile is saved (center) and can then be accessed {\sl via} the {\sl Colour} menu (right).}
1596 \label{usercol}
1597 \end{center}
1598 \end{figure}
1599
1600 \exercise{Colouring Alignments}{
1601 \label{color}
1602 Note: Ensure that the {\sl Apply Colour
1603 To All Groups} flag is not selected in {\sl Colour} menu in the alignment window.
1604 % patch needed for 2.10 This must be turned {\sl off} specifically as it is on
1605 % by default.
1606
1607 \exstep{Open a sequence alignment, for example the PFAM domain PF03460 in PFAM
1608 seed database. Select the alignment menu option {\sl Colour $\Rightarrow$
1609 Clustalx} and note the colour change. Now try all the other colour schemes in the {\sl Colour} menu. 
1610 Note that some colour schemes do not colour all residues.}
1611 \exstep{Colour the alignment using {\sl Colour  $\Rightarrow$ Blosum62 score}. Select a group
1612 of around 4 similar sequences. Use the context menu (right click on the group)
1613 option {\sl Selection $\Rightarrow$ Edit New Group $\Rightarrow$ Group Colour
1614 $\Rightarrow$ Blosum62 score} to colour the selection. Notice how some residues which
1615 were not coloured are now coloured. The calculations performed for dynamic
1616 colouring schemes like Blosum62 are based on the selected group,
1617 not the whole alignment. (This also explains the colouring changes observed in exercise
1618 \ref{exselect} during the group selection step).}
1619 \exstep{Keeping the same selection as before, colour the complete alignment except
1620 the group using {\sl Colour  $\Rightarrow$ Taylor}.
1621 Select the menu option  {\sl Colour  $\Rightarrow$ By Conservation}. 
1622 Slide the selector in the Conservation Colour Increment dialog box from side
1623 to side and observe the changes in the alignment colouring in the selection and in the complete alignment.}
1624 Note: Feature colours overlay residue colouring. The features colours can be
1625 toggled off by going to {\sl View  $\Rightarrow$ Show Sequence Features}.
1626
1627 {\bf See the video at: \url{http://www.jalview.org/training/Training-Videos}.}
1628 }
1629
1630
1631 \exercise{User Defined Colour Schemes}{
1632 \label{colouex}
1633 \exstep{Load a sequence alignment PF03460 from the PFAM
1634 seed database. Ensure that the {\sl Colour  $\Rightarrow$
1635 None} is selected. Select the alignment menu option {\sl Colour $\Rightarrow$
1636 User Defined}.
1637 A dialog window will open.}
1638 \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.}
1639 \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.}
1640 \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.
1641
1642 {\bf See the video at:
1643 \url{http://www.jalview.org/training/Training-Videos}.}} }
1644
1645 \exercise{Alignment Layout}{
1646 \label{exscreen}
1647 \exstep{Start Jalview and open the URL \textsf{http://www.jalview.org/examples/exampleFile.jvp}. 
1648 Select {\sl Format $\Rightarrow$ Wrap} from the alignment window menu. 
1649 Experiment with the various options from the {\sl Format} menu, for example adjust the ruler placement, 
1650 sequence ID format and so on. }
1651 \exstep{Hide all the annotation rows by toggling {\sl Annotations $\Rightarrow$
1652 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
1653 annotation row labels to bring up the context menu, then select {\sl
1654 Hide This Row}. Bring up the context menu again and select {\sl
1655 Show All Hidden Rows} to reveal them.}
1656 \exstep{Annotations can be reordered by clicking on the annotations name and
1657 dragging the row to the desired position. Click on the {\sl Consensus} row and drag it upwards to just above {\sl Quality}. 
1658 The rows should now be reordered. Features and annotations are covered in more detail in Section \ref{featannot}.}
1659 \exstep{Move the mouse to the top left hand corner of the annotation labels - 
1660 a up/down arrow symbol should appear - when this is shown, the height of the {\sl Annotation Area} can be changed 
1661 by clicking and dragging this icon up or down.}
1662 \bf See the video at:
1663 \url{http://www.jalview.org/training/Training-Videos}.}
1664
1665 \section{Formatting and Graphics Output}
1666 \label{layoutandoutput}
1667 Jalview is a WYSIWIG alignment editor. This means that for most kinds of graphics output, 
1668 the layout that is seen on screen will be the same as what is outputted in an
1669 exported graphics file.
1670 It is therefore important to pick the right kind of display layout prior to generating figures. 
1671
1672 \subsection{Multiple Alignment Views}
1673
1674 Jalview is able to create multiple independent visualizations of the same underlying alignment - these are called {\bf Views}. 
1675 Because each view displays the same underlying data, any edits performed in one view will update the alignment or annotation visible in all views.
1676
1677 \parbox[c]{4in}{Alignment views are created using the {\sl View $\Rightarrow$
1678 New View} option of the alignment window or by pressing [CTRL]-T.
1679 This will create a new view with the same groups, alignment layout and display options as the current one. 
1680 Pressing G key will gather together Views as named tabs on the alignment window, and pressing X key will expand gathered Views so they can be viewed 
1681 simultaneously in their own separate windows.} \parbox[c]{2.75in}{
1682 \begin{center}\centerline{
1683 \includegraphics[width=2.5in]{images/mulv_tabs.pdf}}
1684 \end{center}
1685 }
1686
1687 To delete a view, press [CTRL]-W (or [CMD]-W (Mac)).
1688 To rename a view, right click the view's name, this open the Enter View Name dialogue box, enter the desired name.
1689 % JBPNote make an excercise on views ?
1690
1691 \subsection{Alignment Layout}
1692 Jalview provides two screen layout modes, unwrapped (the default) where the alignment is in one long line across the window, and wrapped, 
1693 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 
1694 alignment window, and control the overall look of the alignment in the view (rather than just a selected region).
1695
1696 \subsubsection{Wrapped Alignments}
1697 Wrapped alignments can be toggled on and off using the {\sl Format $\Rightarrow$ Wrap} menu option (Figure \ref{wrap}). Note that 
1698 the annotation tracks are also wrapped. Wrapped alignments are great for publications and presentations but are of limited use when 
1699 working with large numbers of sequences. 
1700
1701 If annotations are not all visible in wrapped mode, expand the alignment window to view them. Note that alignment annotation 
1702 (see Section \ref{featannot}) cannot be interactively created or edited in wrapped mode, and selection of large regions is difficult. 
1703 \begin{figure}[htbp]
1704 \begin{center}
1705 \parbox[c]{2in}{\includegraphics[width=2in]{images/wrap1.pdf}}
1706 \parbox[c]{4in}{\includegraphics[width=4in]{images/wrap2.pdf}}
1707 \caption{{\bf Wrapping the alignment.}}
1708 \label{wrap}
1709 \end{center}
1710 \end{figure}
1711
1712
1713 \subsubsection{Fonts}
1714
1715 \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 
1716 applies for all alignment and annotation text except for that displayed in tool-tips. Additionally, font size and spacing can be adjusted rapidly by 
1717 clicking the middle mouse button and dragging across the alignment window.}
1718 \parbox[c]{2in}{\centerline{\includegraphics[width=1.75in]{images/font.pdf}}}
1719
1720 \subsubsection{Numbering and Label Justification}
1721 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 
1722 alignment numbering, the justification of sequence IDs and annotation row column labels on the annotation rows shown below the alignment.
1723
1724 \subsubsection{Alignment and Group Colouring and Appearance}
1725 The display of hidden row/column markers and gap characters can be turned off with {\sl Format $\Rightarrow$ Show Hidden Markers} and 
1726 {\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.  
1727
1728 \subsubsection{Highlighting Nonconserved Symbols}
1729 The alignment layout and group sub-menu both contain an option to hide
1730 conserved symbols from the alignment display ({\sl Format $\Rightarrow$ Show
1731 nonconserved } in the alignment window or {\sl Selection $\Rightarrow$ Group
1732 $\Rightarrow$ Show Nonconserved} by right clicking on a group). This mode is useful when working with
1733 alignments that exhibit a high degree of homology, because Jalview will only
1734 display gaps or sequence symbols that differ from the consensus for each
1735 column, and render all others with a `.'.
1736 %TODO add a graphic to illustrate this.
1737
1738 \subsection{Annotation Ordering and Display}
1739 % TODO: describe consensus, conservation, quality user preferences, and group
1740 % annotation preferences.
1741 The annotation lines which appear below the sequence alignment are described in
1742 detail in Section \ref{featannot}. They can be hidden by toggling the {\sl Annotations
1743 $\Rightarrow$ Show annotations} menu option. Additionally, each annotation line
1744 can be hidden and revealed in the same way as sequences {\sl via} the
1745 pop-up context menu on the annotation name panel (Figure \ref{annot}).
1746 Annotations can be reordered by dragging the annotation line label on the annotation label panel. Placing the
1747 mouse over the top annotation label brings up a resize icon on the left. When this is
1748 displayed, click-dragging up and down provides either more space in the alignment window for viewing the annotations, or 
1749 less space for the sequence alignment.
1750
1751 \begin{figure}
1752 \begin{center}
1753 \includegraphics[width=2.5in]{images/annot1.pdf}
1754 \includegraphics[width=2.5in]{images/annot2.pdf}
1755 \caption{{\bf Hiding Annotations} Annotations can either be hidden from the {\sl
1756 Annotations} menu (left) or individually from the context menu opened by right clicking their label (right).}
1757 \label{annot}
1758 \end{center}
1759 \end{figure}
1760
1761 %%TODO: multiple views - simple edits - observe changes in other views.
1762
1763
1764 \subsection{Graphical Output}
1765 \label{figuregen}
1766 \parbox[c]{4in}{Jalview allows alignments figures to be exported in different formats, each of which is suited to a particular purpose. 
1767 Image export is {\sl via} the {\sl File $\Rightarrow$ Export Image $\Rightarrow$ \ldots } alignment window menu option. }
1768 \parbox[c]{2in}{\centerline{\includegraphics[width=2in]{images/image.pdf}}}
1769
1770 \subsubsection{HTML}
1771
1772 \parbox[c]{4in}{HTML is the format used by web pages. Jalview outputs the
1773 alignment as a 'Scalable Vector Graphics' (or SVG) file with all the colours and fonts as seen, which is in turn embedded as a 
1774 scrollable component within an HTML page.
1775 %% 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. 
1776 This file can then be viewed directly with any web browser. Unwrapped alignments will produce a very wide page. Export options allow 
1777 original data to be embedded in the HTML file as BioJSON.\footnote{BioJSON was introduced in Jalview 2.9 and fully described 
1778 at \url{https://jalview.github.io/biojson/}}}
1779 \parbox[c]{3.5in}{\centerline{\includegraphics[width=3in]{images/image_html.pdf}}}
1780
1781 \subsubsection{EPS}
1782 \parbox[c]{4in}{EPS is Encapsulated Postscript. {\bf It is the format of choice
1783 for publications and posters} as it gives the highest quality output of any of
1784 the image types. It can be scaled to any size, so will still look good on an A0
1785 poster.
1786 This format can be read by most good presentation and graphics packages such as Adobe Illustrator or Inkscape.
1787 }
1788 \parbox[c]{4in}{\centerline{\includegraphics[width=2in]{images/image_eps.pdf}}
1789 \par \centerline{Zoom Detail of EPS image.}}
1790
1791 \subsubsection{PNG}
1792 \parbox[c]{4in}{
1793 PNG is Portable Network Graphics. This output option produces an image that can be easily included in web pages and incorporated in 
1794 presentations using e.g. Powerpoint or Open Office. It is a bitmap image so does not scale and is unsuitable for use on posters, 
1795 or in publications.
1796
1797 For submission of alignment figures to journals, please use EPS\footnote{If the journal complains, {\em insist}.}.
1798 }
1799 \parbox[c]{4in}{\centerline{\includegraphics[width=2in]{images/image_png.pdf}}
1800 \par \centerline{Zoom Detail of PNG image.}}
1801
1802  \exercise{Graphical Output}{
1803  \label{graphicex}
1804 \exstep{Load the example Jalview Jar file in Exercise \ref{exscreen}. 
1805 Customise it how you wish but leave it unwrapped. 
1806 Select {\sl File $\Rightarrow$ Export Image $\Rightarrow$ HTML} from the alignment menu. 
1807 Save the file and open it in your favoured web browser.  }
1808 \exstep{Wrap the alignment and export the image to HTML again. Compare the two
1809 images. (Note that the exported image matches the format displayed in the
1810 alignment window but {\bf annotations are not exported}).}
1811 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image $\Rightarrow$ PNG} menu option. 
1812 Open the file in an image viewer that allows zooming such as Paint or Photoshop (Windows), or Preview (Mac OS X) and zoom in. 
1813 Notice that the image is a bitmap and it becomes pixelated when zoomed. 
1814 (Note that the {\bf annotation lines are included} in the image.)}
1815 \exstep{Export the alignment using the {\sl File $\Rightarrow$ Export Image
1816 $\Rightarrow$ EPS} menu option. Open the file in a suitable program such as
1817 Photoshop, Illustrator, Inkscape, Ghostview, Powerpoint (Windows), or
1818 Preview (Mac OS X). Zoom in and note that the image has near-infinite
1819 resolution.}
1820 \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 ?}
1821 \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 ?}
1822 \bf See the video at:
1823 \url{http://www.jalview.org/training/Training-Videos}.
1824 }
1825
1826 % left out for Glasgow 2016
1827 % \newpage
1828
1829 % \section{Summary - the rest of the manual}
1830
1831 % The first few chapters have covered the basics of Jalview operation: from
1832 % starting the program, importing, exporting, selecting, editing and colouring
1833 % aligments, to the generation of figures for publication, presentation and web
1834 % pages.
1835
1836 % The remaining chapters in the manual cover:
1837
1838 % \begin{list}{$\circ$}{}
1839 % \item{Chapter \ref{featannot} covers the creation, manipulation and visualisation
1840 % of sequence and alignment annotation, and retrieval of sequence and feature data
1841 % from databases.}
1842 % \item {Chapter \ref{msaservices} explores the range of multiple alignment
1843 % programs offered via Jalview's web services, and introduces the use of
1844 % AACon for protein multiple alignment conservation analysis.}
1845 % \item {Chapter \ref{alignanalysis} introduces Jalview's built in tools for
1846 % multiple sequence alignment analysis, including trees, PCA, and alignment
1847 % conservation analysis. }
1848 % \item {Chapter \ref{3Dstructure} demonstrates the structure visualization
1849 % capabilities of Jalview.}
1850 % \item {Chapter \ref{proteinprediction} introduces protein sequence based
1851 % secondary structure and disorder prediction tools, including JPred.}
1852 % \item {Chapter \ref{dnarna} covers the special functions and
1853 % visualization techniques for working with RNA alignments and protein coding
1854 % sequences.}
1855 % \item {Chapter \ref{jvwebservices} provides instructions on the
1856 % installation of your own Jalview web services.}
1857 % \end{list}
1858
1859 \chapter{Annotation and Features}
1860 \label{featannot}
1861 Annotations and features are additional information that is
1862 overlaid on the sequences and the alignment.
1863 Generally speaking, annotations reflect properties of the alignment as a
1864 whole, often associated
1865 with columns in the alignment. Features are often associated with specific
1866 residues in the sequence.
1867
1868 Annotations are shown below the alignment in the annotation panel, the
1869 properties are often based on the alignment.
1870 Conversely, sequence features are properties of the individual sequences, so they do not change with the alignment, 
1871 but are shown mapped on to specific residues within the alignment. 
1872
1873 Features and annotation can be interactively created, or retrieved from external
1874 data sources. Webservices like JPred (see \ref{jpred}) can be used to
1875 analyse a given sequence or alignment and generate annotation for it.
1876
1877
1878 \section{Conservation, Quality, Consensus and other Annotation}
1879 \label{annotationintro}
1880 Jalview automatically calculates several quantitative alignment annotations
1881 which are displayed as histograms below the multiple sequence alignment columns. 
1882 Conservation, quality and consensus scores are examples of dynamic
1883 annotation, so as the alignment changes, they change along with it.
1884 The scores can be used in the hybrid colouring options to shade the alignments. 
1885 Mousing over a conservation histogram reveals a tooltip with more information.
1886
1887 These annotations can be hidden and deleted via the context menu linked to the
1888 annotation row; but they are only created on loading an alignment. If they are
1889 deleted then the alignment should be saved and then reloaded to restore them.
1890 Jalview provides a toggle to autocalculate a consensus sequence upon editing. This is normally selected by default, but can be turned off for
1891 large alignments {\sl via} the {\sl Calculate $\Rightarrow$ Autocalculate
1892 Consensus} menu option if the interface is too slow.
1893
1894 \subsubsection{Conservation Annotation}
1895
1896 Alignment conservation annotation is quantitative numerical index reflecting the
1897 conservation of the physico-chemical properties for each column of the alignment. 
1898 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), 
1899 with identities scoring highest, and amino acids with substitutions in the same physico-chemical class have next highest score. 
1900 The score for each column is shown below the histogram. 
1901 The conserved columns with a score of 11 are indicated by '*'.
1902 Columns with a score of 10 have mutations but all properties are conserved are marked with a '+'.
1903
1904 \subsubsection{Consensus Annotation}
1905
1906 Alignment consensus annotation reflects the percentage of the different residue
1907 per column. By default this calculation includes gaps in columns, gaps can be ignored via the Consensus label context 
1908 menu to the left of the consensus bar chart. 
1909 The consensus histogram can be overlaid
1910 with a sequence logo that reflects the symbol distribution at each column of
1911 the alignment. Right click on the Consensus annotation row and select the {\sl Show
1912 Logo} option to display the Consensus profile for the group or alignment.
1913 Sequence logos can be enabled by default for all new alignments {\sl via} the
1914 Visual tab in the Jalview desktop's preferences dialog box.
1915
1916 \subsubsection{Quality Annotation}
1917
1918 Alignment quality annotation is an ad-hoc measure of the likelihood of observing
1919 the mutations (if any) in a particular column of the alignment. The quality score is calculated for each column in an alignment by summing, 
1920 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). 
1921 This value is normalised for each column, and then plotted on a scale from 0 to 1.
1922
1923 \subsubsection{Occupancy Annotation}
1924
1925 Alignment occupancy simply reflects the number of residues aligned at each column
1926 in the multiple sequence alignment. To see this annotation you may first need to enable it by ticking the {\sl Occupancy} check-box
1927 in the {\sl Visual} tab in Jalview's {\sl Preferences} before opening an alignment. Occupancy is particularly useful in conjunction with
1928 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.
1929
1930 \subsubsection{Group Associated Annotation}
1931 \label{groupassocannotation}
1932 Group associated consensus and conservation annotation rows reflect the
1933 sequence variation within a particular group. Their calculation is enabled
1934 by selecting the {\sl Group Conservation} or {\sl Group Consensus} options in
1935 the {\sl Annotation $\Rightarrow$ Autocalculated Annotation } submenu of the
1936 alignment window. 
1937
1938 \subsection{Creating User Defined Annotation}
1939
1940 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}).
1941 A dialog box appears. Enter the label to use for this row and a new row will appear.
1942
1943 To create a new annotation, first select all the positions to be annotated on the appropriate row. 
1944 Right-clicking on this selection brings up the context menu which allows the insertion of graphics for secondary structure ({\sl Helix} or {\sl Sheet}), 
1945 text {\sl Label} and the colour in which to present the annotation (Figure \ref{newannot}). On selecting {\sl Label} a dialog box will appear, 
1946 requesting the text to place at that position. After the text is entered, the selection can be removed and the annotation becomes clearly 
1947 visible\footnote{When annotating a block of positions, the text can be partly obscured by the selection highlight. Pressing the  [ESC] key clears 
1948 the selection and the label is then visible.}. Annotations can be coloured or deleted as desired.
1949
1950 \begin{figure}[htbp]
1951 \begin{center}
1952 \includegraphics[width=1.3in]{images/annots1.pdf}
1953 \includegraphics[width=2in]{images/annots2.pdf}
1954 \caption{{\bf Creating a new annotation row.} Annotation rows can be reordered by dragging them to the desired place.}
1955 \label{newannotrow}
1956 \end{center}
1957 \end{figure}
1958
1959 \begin{figure}[htbp]
1960 \begin{center}
1961 \includegraphics[width=2in]{images/annots3.pdf}
1962 \includegraphics[width=2in]{images/annots4.pdf}
1963 \includegraphics[width=2in]{images/annots5.pdf}
1964 \caption{{\bf Creating a new annotation.} Annotations are created from a selection on the annotation row and can be coloured as desired.}
1965 \label{newannot}
1966 \end{center}
1967 \end{figure}
1968
1969 \subsection{Automated Annotation of Alignments and Groups}
1970
1971 On loading a sequence alignment, Jalview will normally\footnote{Automatic
1972 annotation can be turned off in the {\sl Visual } tab in the {\sl Tools
1973 $\Rightarrow$ Preferences } dialog box.} calculate a set of automatic annotation
1974 rows which are shown below the alignment. For nucleotide sequence alignments,
1975 only an alignment consensus row will be shown, but for amino acid sequences,
1976 alignment quality (based on BLOSUM 62) and physicochemical conservation will
1977 also be shown. Conservation is calculated according to Livingstone and
1978 Barton\footnote{{\sl ``Protein Sequence Alignments: A Strategy for the
1979 Hierarchical Analysis of Residue Conservation." } Livingstone C.D. and Barton
1980 G.J. (1993) {\sl CABIOS } {\bf 9}, 745-756}.
1981 Consensus is the modal residue (or {\tt +} where there is an equal top residue).
1982 The inclusion of gaps in the consensus calculation can be toggled by
1983 right-clicking on the Consensus label and selecting {\sl Ignore Gaps in
1984 Consensus} from the pop-up context menu located with consensus annotation row.
1985 Quality is a measure of the inverse likelihood of unfavourable mutations in the alignment. Further details on these
1986 calculations can be found in the on-line documentation.
1987
1988
1989 \exercise{Annotating Alignments}{
1990   \label{annotatingalignex}
1991 \exstep{Load the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
1992 Right-click on the label name of the {\sl Conservation} annotation row to
1993 bring up the context menu and select {\sl Add New Row}. A dialog box will
1994 appear asking for {\sl Annotation Name} and {\sl Annotation Description}.
1995 Enter "Iron binding site" and click {\sl OK}. A new, empty, row appears.
1996 }
1997 \exstep{
1998 Navigate to column 97. Move down and on the new annotation row called
1999 "Iron binding site", select column 97.
2000 Right click at this selection and select {\sl Label} from the context menu.
2001 Enter "Fe" in the box and click {\sl OK}. Right-click on the selection again
2002 and select {\sl Colour}.
2003 Choose a colour from the colour chooser dialog 
2004 and click {\sl OK}. Press [ESC] to remove the selection.
2005
2006 {\sl Note: depending on your Annotation sort settings, your newly
2007 created annotation row might "jump" to the top or bottom of the annotation
2008 panel. Just scroll up or down to find it again - the column you marked will
2009 still be selected. }
2010
2011 }
2012 \exstep{ Select columns 70-77 on the annotation row. Right-click and choose {\sl Sheet} from the
2013  context menu. You will be prompted for a label. Enter "B" and press {\sl OK}. A new line showing the 
2014  sheet as an arrow appears. The colour of the label can be changed but not the colour of the sheet 
2015  arrow. 
2016 }
2017 \exstep{Right click on the title text in the annotation row that you just
2018 created.
2019 Select {\sl Export Annotation} in context menu and, in the Export Annotation
2020 dialog box that will open, select the Jalview format and click the {\sl [To Textbox]} button. 
2021 (The format for this file is given in the Jalview help. Press [F1] to open it ([F1]-[Fn] (Mac)),
2022 and find the "Annotations File Format" entry in the "Alignment Annotations" section of the contents 
2023 pane.) }
2024
2025 \exstep{Open a text editor and copy the annotation text into the editor.
2026 Edit the text by changing the name of the annotation row and save the file.}
2027 \exstep{Drag the file onto the alignment in Jalview and check the annotation
2028 panel.} \exstep{Return to the text editor, add an additional helix somewhere
2029 along the row, save the file and re-importing it into Jalview as previously.
2030 {\sl Hint: Use the Export Annotation function to view what helix annotation looks like in 
2031 a Jalview annotation file.}}
2032 \exstep{In the alignment window menu, select {\sl File $\Rightarrow$ Export Annotations...} 
2033 to export all the alignment's annotation to a file. Save the file.}
2034 \exstep{Open the exported annotation in a text editor, and use the Annotation File Format 
2035 documentation to modify the style of the Conservation, Consensus and Quality annotation rows so 
2036 they appear as several lines on a single line graph.
2037 {\sl Hint: You need to change the style of annotation row in the first field of the annotation 
2038 row entry in the file. Create an annotation row grouping to overlay the
2039 three quantitative annotation rows.}
2040 }
2041 \exstep{{\bf Homework once you have completed exercise
2042 \ref{secstrpredex}:}
2043 \label{viewannotfileex}
2044       
2045 Recover or recreate the secondary structure predictions that you made from
2046 JPred. Use the {\sl File $\Rightarrow$ Export Annotation} function to view the Jnet secondary structure prediction annotation row.
2047 Note: the 
2048 SEQUENCE\_REF statements surrounding the row specifying the sequence association for the 
2049 annotation. 
2050 }
2051 \bf See the video at:
2052 \url{http://www.jalview.org/training/Training-Videos}.}
2053
2054
2055 \section{Sequence Features}
2056 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.
2057
2058 \begin{figure}[htbp]
2059 \begin{center}
2060 \includegraphics[width=2in]{images/feature1.pdf}
2061 \includegraphics[width=2.5in]{images/feature2.pdf}
2062 \includegraphics[width=1.5in]{images/feature3.pdf}
2063 \caption{{\bf Creating sequence features.} Features can readily be created from selections via the context menu and are then displayed on the sequence. }
2064 \label{features}
2065 \end{center}
2066 \end{figure}
2067
2068 Creation of features from a selection spanning multiple sequences results in the creation of one feature per sequence. 
2069 Each feature remains associated with its own sequence.
2070
2071 %%TODO: change EMBL to ENA in Jalview and the Manual !
2072
2073 \section{Importing Features from Databases}
2074 \label{featuresfromdb}
2075 Jalview supports feature retrieval from public databases.
2076 It includes built in parsers for Uniprot, Ensembl and ENA (or EMBL) records retrieved
2077 from the EBI. Sequences retrieved from these sources using the sequence fetcher (see
2078 Section \ref{fetchseq}) will already possess features.
2079
2080
2081 \begin{figure}[htbp]
2082 \begin{center}
2083 \includegraphics[width=4in]{images/features4.pdf}
2084 \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.}
2085 \end{center}
2086 \end{figure}
2087
2088
2089 \subsection{Sequence Database Reference Retrieval}
2090 \label{fetchdbrefs}
2091 Jalview maintains a list of external database references for each sequence in
2092 an alignment. These are listed in a tooltip when the mouse is moved over the
2093 sequence ID when the {\sl View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$
2094 Show Database Refs } option is enabled. Sequences retrieved using the sequence
2095 fetcher will always have at least one database reference, but alignments
2096 imported from an alignment file generally have no database references.
2097
2098 \subsubsection{Database References and Sequence Coordinate Systems}
2099
2100 Jalview displays features in the local sequence's coordinate system which is
2101 given by its `start' and `end'. Any sequence features on the sequence will be
2102 rendered relative to the sequence's start position. If the start/end positions
2103 do not match the coordinate system from which the features were defined, then
2104 the features will be displayed incorrectly.
2105
2106 \subsubsection{Viewing and Exporting a Sequence's Database Annotation}
2107
2108 You can export all the database cross references and annotation terms shown in
2109 the sequence ID tooltip for a sequence by right-clicking and selecting the {\sl
2110 [Sequence ID] $\Rightarrow$ Sequence Details} option from the popup
2111 menu.
2112 A similar option is provided in the {\sl Selection} sub-menu allowing you to
2113 obtain annotation for the sequences currently selected. 
2114
2115 \parbox[l]{3.4in}{
2116 The {\sl Sequence Details
2117 \ldots} option will open a window containing the same text as would be shown in
2118 the tooltip window, including any web links associated with the sequence. The
2119 text is HTML, and options on the window allow the raw code to be copied and
2120 pasted into a web page.}
2121 \parbox[c]{3in}{
2122 \centerline{\includegraphics[width=2.2in]{images/seqdetailsreport.pdf}}}
2123
2124 \subsubsection{Automatically Discovering a Sequence's Database References}
2125 Jalview includes a function to automatically verify and update each sequence's
2126 start and end numbering against any of the sequence databases that the {\sl
2127 Sequence Fetcher} has access to. This function is accessed from the {\sl
2128 Web Service $\Rightarrow$ Fetch DB References} sub-menu in the Alignment
2129 window. This menu allows you to query either the set of {\sl Standard
2130 Databases}, which includes EMBL, Ensembl, Uniprot, the PDB, or just a specific datasource from one of the submenus.
2131 When one of the entries from this menu is selected, Jalview will use the ID
2132 string from each sequence in the alignment or in the currently selected set to
2133 retrieve records from the external source. Any sequences that are retrieved are
2134 matched against the local sequence, and if the local sequence is found to be a
2135 sub-sequence of the retrieved sequence then the local sequence's start/end
2136 numbering is updated.  A new database reference mapping is created, mapping the
2137 local sequence to the external database, and the local sequence inherits any
2138 additional annotation retrieved from the database sequence.
2139
2140 The database retrieval process terminates when a valid mapping is found for a
2141 sequence, or if all database queries failed to retrieve a matching sequence.
2142 Termination is indicated by the disappearance of the moving progress indicator
2143 on the alignment window. A dialog box may be shown once it completes which
2144 lists sequences for which records were found, but the sequence retrieved from
2145 the database did not exactly contain the sequence given in the alignment (the
2146 {\sl ``Sequence not 100\% match'' dialog box}).
2147
2148
2149 \subsubsection{Rate of Feature Retrieval}
2150 Feature retrieval can take some time if a large number of sources are selected
2151 and if the alignment contains a large number of sequences.  
2152 As features are retrieved, they are immediately added to the current alignment view.
2153 The retrieved features are shown on the sequence and can be customised as described previously.
2154
2155
2156 \subsection{Customising Feature Display}
2157
2158 \begin{figure}[htbp]
2159 \begin{center}
2160 \includegraphics[width=5in]{images/features5.pdf}
2161 \caption{{\bf Customising sequence features.} Features can be recoloured, switched on or off and have the rendering order changed. }
2162 \label{custfeat}
2163 \end{center}
2164 \end{figure}
2165
2166 Feature display can be toggled on or off by selecting the {\sl View
2167 $\Rightarrow$ Show Sequence Features} menu option. When multiple features are
2168 present it is usually necessary to customise the display. Jalview allows the
2169 display, colour, rendering order and transparency of features to be modified
2170 {\sl via} the {\sl View $\Rightarrow$ Feature Settings\ldots} menu option. This
2171 brings up a dialog window (Figure \ref{custfeat}) which allows the
2172 visibility of individual feature types to be selected, assigned colours to be changed (by
2173 clicking on the colour of each sequence feature type) and the rendering order
2174 modified by dragging feature types to a new position in the list. Dragging the
2175 slider alters the transparency of the feature rendering. Clicking in the {\sl Configuration} column
2176  opens the {\sl Display Settings} dialog which allows more complex shading schemes 
2177  and also the creation of filters, and right-clicking opens a context sensitive menu
2178   that offers options for selecting and hiding columns or sorting the alignment according the feature's distribution or score attribute.
2179 These capabilities are described further in sections
2180 \ref{featureschemes} and \ref{featureordering}.
2181
2182
2183 \subsection{Changing how Features are coloured and displayed}
2184 \label{featureschemes}
2185 Sometimes, you may need to visualize the differences in information carried by
2186 sequence features of the same type. This is most often the case when features
2187 of a particular type are the result of a specific type of database query or calculation.
2188 Here, they may also carry information within their textual description, or most commonly
2189 for calculations, a score related to the property being investigated. Features imported
2190 from genomic databases and Variant Call Format files may also have a number of additional
2191 attributes. Jalview allow filters and different types of colouring to be applied to allow variations in these attributes to be highlighted.
2192 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. 
2193
2194 Instead of shading a feature with an assigned colour according to its type, you can select the `Colour by text'
2195 option to create feature colours according to the description text associated
2196 with each feature. This is useful for general feature types - such as
2197 Uniprot's `DOMAIN' feature - where the actual type of domain is given in the
2198 feature's description. If other attributes are present you can choose one of them from the drop-down menu.
2199
2200 If Scores or numeric attributes are present, the {\sl Graduated Colour} section of the dialog allows a quantitative
2201 shading scheme to be defined, with the highest
2202 scores receiving the `Max' colour, and the lowest scoring features coloured
2203 with the `Min' colour. Alternately, 
2204 you can define a threshold to exclude low or
2205 high-scoring features from the alignment display. This is done by choosing your
2206 desired threshold type (either above or below), using the drop-down menu in the
2207 dialog box. Then, adjust the slider or enter a value in the text box to set the
2208 threshold for displaying this type of feature.
2209
2210 When a filters and complex colourschemes are applied, the configuration column will show coloured blocks or text to indicate the colouring
2211 style and any attribute filters. 
2212
2213
2214 \subsection{Using Features to Re-order the Alignment}
2215 \label{featureordering}
2216 The presence of sequence features on certain sequences or in a particular
2217 region of an alignment can quantitatively identify important trends in
2218 the aligned sequences. In this case, it is more useful to
2219 re-order the alignment based on the number of features or their associated scores, rather than simply re-colour the aligned sequences. 
2220 The sequence feature settings
2221 dialog box provides two buttons: `Sequence sort by Density' and `Sequence sort by
2222 Score', that allow you to reorder the alignment according to the number of
2223 sequence features present on each sequence, and also according to any scores
2224 associated with a feature. Each of these buttons uses the currently displayed
2225 features to determine the ordering, but
2226 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
2227 popup menu. Simply right-click the type's style in the Sequence Feature Settings dialog
2228 box, and select one of the {\sl Sort by Score} and {\sl Sort by Density}
2229 options to re-order the alignment. Finally, if a specific region is selected,
2230 then only features found in that region of the alignment will be used to
2231 create the new alignment ordering.
2232 % \exercise{Shading and Sorting Alignments using Sequence Features}{
2233 % \label{shadingorderingfeatsex}
2234
2235 % This exercise is currently not included in the tutorial because no DAS servers
2236 % currently exist that yield per-residue features for any Uniprot sequence. 
2237
2238 % \exstep{Re-load the alignment from \ref{dasfeatretrexcercise}.
2239 % }
2240 % \exstep{Open the
2241 % feature settings panel, and, after first clearing the current
2242 % selection, press the {\em Seq Sort by Density} button a few times.}
2243 % \exstep{Use the DAS fetcher to retrieve the Kyte and Doolittle Hydrophobicity
2244 % scores for the protein sequences in the alignment.
2245 % {\sl Hint: the nickname for the das source is `KD$\_$hydrophobicity'.}}
2246 % \exstep{Change the feature settings so only the hydrophobicity features are
2247 % displayed. Mouse over the annotation and also export and examine the GFF and
2248 % Jalview features file to better understand how the hydrophobicity measurements
2249 % are recorded.}
2250 % \exstep{Apply a {\sl Graduated Colour} to the hydrophobicity annotation to
2251 % reveal the variation in average hydrophobicity across the alignment.}
2252 % \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
2253 % hydrophobicity.}
2254 % \exstep{Save the alignment as a project, for use in exercise
2255 % \ref{threshgradfeaturesex}.} }
2256
2257 % \exercise{Shading alignments with combinations of graduated feature
2258 % colourschemes}{
2259 % \label{threshgradfeaturesex}
2260 % \exstep{Reusing the annotated alignment from exercise
2261 % \ref{shadingorderingfeatsex}, experiment with the colourscheme threshold to
2262 % 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.}
2263 % \exstep{Change the colourscheme so
2264 % that features at the threshold are always coloured grey, and the most
2265 % hydrophobic residues are coloured red, regardless of the threshold value
2266 % ({\em hint - there is a switch on the dialog to do this for you}).}
2267 % \exstep{Enable the Uniprot {\em chain} annotation in the feature settings
2268 % display and re-order the features so it is visible under the hydrophobicity
2269 % annotation.}
2270 % \exstep{Apply a {\sl Graduated Colour} to the {\em chain}
2271 % annotation so that it distinguishes the different canonical names associated
2272 % with the mature polypeptide chains.}
2273 % \exstep{Export the alignment's sequence features using the Jalview and GFF file formats, to see how the different types of graduated feature
2274 % colour styles are encoded. }
2275 % }
2276
2277
2278 \subsection{Sequence Feature File Formats}
2279
2280 Jalview supports the widely used GFF tab delimited format\footnote{see
2281 http://www.sanger.ac.uk/resources/software/gff/spec.html} and its own Jalview
2282 Features file format for the import of sequence annotation. Features and
2283 alignment annotation are also extracted from other formats such as Stockholm,
2284 and AMSA. URL links may also be attached to features. See the online
2285 documentation for more details of the additional capabilities of the Jalview
2286 features file.
2287
2288 \exercise{Creating Features}{
2289 \label{featuresex}
2290 \exstep{Open the alignment at \textsf{http://www.jalview.org/tutorial/alignment.fa}. 
2291 We know that the Cysteine residues at columns 97, 102, 105 and 135 are involved in 
2292 iron binding so we will create them as features. Navigate to column 97, sequence 1. 
2293 Select the entire column by clicking in the ruler bar. Then right-click on the selection 
2294 to bring up the context menu and select {\sl Selection $\Rightarrow$ Create Sequence Feature}. 
2295 A dialog box will appear.
2296 }
2297 \exstep{
2298 Enter a suitable Sequence Feature Name  (e.g. ``Iron binding site") in the
2299 appropriate box. Click on the Feature Colour bar to change the colour if
2300 desired, add a short description (``One of four Iron binding Cysteines") and
2301 press {\sl OK}. The features will then appear on the sequences. } \exstep{Roll
2302 the mouse cursor over the new features.
2303 Note that the position given in the tool tip is the residue number, not the column number. 
2304 To demonstrate that there is one feature per sequence, clear all selections by pressing [ESC],
2305  then insert a gap in sequence 3 at column 95 using the [SHIFT] key.
2306 Roll the mouse over the features and you will see that the feature has moved
2307 with the sequence. Delete the gap you created using {\sl Edit
2308 $\Rightarrow$ Undo}.
2309 }
2310 \exstep{
2311 Add a similar feature to column 102. When the feature dialog box appears, clicking the Sequence Feature 
2312 Name box brings up a list of previously described features. Using the same Sequence Feature Name allows the features to be grouped.}
2313 \exstep{Select {\sl View $\Rightarrow$ Feature Settings\ldots} from the
2314 alignment window menu. The Sequence Feature Settings window will appear. Move
2315 this so that you can see the features you have just created. Click the check
2316 box for ``Iron binding site"  under {\sl Display} and note that display of this
2317 feature type is now turned off. Click it again and note that the features are
2318 now displayed. Close the sequence feature settings box by clicking {\sl OK} or
2319 {\sl Cancel}.} 
2320
2321 \exstep{Select {\sl View $\Rightarrow$ Show Sequence Features} from the
2322 alignment window menu. The sequence features are now hidden. Repeat this step and the features are
2323 displayed.}
2324
2325 \bf See the video at:
2326 \url{http://www.jalview.org/training/Training-Videos}.}
2327
2328 \chapter{Multiple Sequence Alignment}
2329 \label{msaservices}
2330 Sequences can be aligned using a range of algorithms provided by JABA web
2331 services, including ClustalW\footnote{{\sl ``CLUSTAL W:
2332 improving the sensitivity of progressive multiple sequence alignment through sequence
2333 weighting, position specific gap penalties and weight matrix choice."} Thompson
2334 JD, Higgins DG, Gibson TJ (1994) {\sl  Nucleic Acids Research} {\bf 22},
2335 4673-80}, Muscle\footnote{{\sl ``MUSCLE: a multiple sequence alignment method
2336 with reduced time and space complexity"} Edgar, R.C.
2337 (2004) {\sl BMC Bioinformatics} {\bf 5}, 113},  MAFFT\footnote{{\sl ``MAFFT: a
2338 novel method for rapid multiple sequence alignment based on fast Fourier
2339 transform"}  Katoh, K., Misawa, K., Kuma, K. and Miyata, T. (2002) {\sl Nucleic
2340 Acids Research} {\bf 30}, 3059-3066.  and {\sl ``MAFFT version 5:
2341 improvement in accuracy of multiple sequence alignment"} Katoh, K., Kuma, K.,
2342 Toh, H. and Miyata, T. (2005) {\sl Nucleic Acids Research} {\bf 33}, 511-518.},
2343 ProbCons,\footnote{PROBCONS: Probabilistic Consistency-based Multiple Sequence
2344 Alignment.
2345 Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S.
2346 (2005) {\sl Genome Research} {\bf 15} 330-340.} T-COFFEE\footnote{T-Coffee:
2347 A novel method for multiple sequence alignments. (2000) Notredame, Higgins and
2348 Heringa {\sl JMB} {\bf 302} 205-217} and Clustal Omega.\footnote{Fast, scalable
2349 generation of high-quality protein multiple sequence alignments using Clustal
2350 Omega. Sievers F, Wilm A, Dineen DG, Gibson TJ, Karplus K, Li W, Lopez R,
2351 McWilliam H, Remmert M, Soding J, Thompson JD, Higgins DG (2011) {\sl Molecular
2352 Systems Biology} {\bf 7} 539
2353 \href{http://dx.doi.org/10.1038/msb.2011.75}{doi:10.1038/msb.2011.75}} Of these,
2354 T-COFFEE is slow but accurate. ClustalW is historically
2355 the most widely used. Muscle is fast and probably best for
2356 smaller alignments. MAFFT is probably the best for large alignments,
2357 however Clustal Omega, released in 2011, is arguably the fastest and most
2358 accurate tool for protein multiple alignment.
2359
2360 \section{Performing a multiple sequence alignment}
2361 To run an alignment web service, select the appropriate method from the {\sl
2362 Web Service $\Rightarrow$  Alignment $\Rightarrow$ \ldots} submenu (Figure
2363 \ref{webservices}). For each service you may either perform an alignment with
2364 default settings, use one of the available presets, or customise the parameters
2365 with the `{\sl Edit and Run ..}' dialog box. Once the job is submitted, a
2366 progress window will appear giving information about the job and any errors that
2367 occur. After successful completion of the job, a new alignment window is opened
2368 with the results, in this case an alignment. By default, the new alignment will be
2369 ordered in the same way as the input sequences. Note: many alignment
2370 programs re-order the input during their analysis and place homologous
2371 sequences close together, the MSA algorithm ordering can be recovered
2372 using the `Algorithm ordering' entry within the {\sl Calculate $\Rightarrow$
2373 Sort } sub menu.
2374
2375 \subsection{Realignment to add sequences to an existing alignment}
2376 The re-alignment option is currently only supported by Clustal  
2377 Omega and ClustalW. When performing a re-alignment, Jalview submits the
2378 current selection to the alignment service complete with any existing gaps.
2379 Realignment with ClustalW is useful when one wishes to align
2380 additional sequences to an existing alignment without any further optimisation
2381 to the existing alignment. ClustalO's realignment works by generating a
2382 probabilistic model (a.k.a HMM) from the original alignment, and then realigns
2383 {\bf all} sequences to this profile. For a well aligned MSA, this process
2384 will simply reconstruct the original alignment (with additional sequences), but
2385 in the case of low quality MSAs, some differences may be introduced.
2386
2387 \begin{figure}[htbp]
2388 \begin{center}
2389 \parbox[c]{1.5in}{\includegraphics[width=1.5in]{images/ws1.pdf}}
2390 \parbox[c]{2.5in}{\includegraphics[width=2.5in]{images/ws2.pdf}}
2391 \parbox[c]{2in}{\includegraphics[width=2in]{images/ws3.pdf}}
2392 \caption{{\bf Multiple alignment via web services} The appropriate method is
2393 selected from the menu (left), a status box appears (centre), and the results
2394 appear in a new window (right).}
2395 \label{webservices}
2396 \end{center}
2397 \end{figure}
2398
2399 \subsection{Alignments of Sequences that include Hidden Regions}
2400 If the view or selected region submitted for alignment contains hidden
2401 regions, then {\bf only the visible sequences will be submitted to the service}.
2402 Furthermore, each contiguous segment of sequences will be aligned independently
2403 (resulting in a number of alignment `subjobs' appearing in the status window).
2404 Finally, the results of each subjob will be concatenated with the hidden regions
2405 in the input data prior to their display in a new window. This approach ensures
2406 that 1) hidden column boundaries in the input data are preserved in the
2407 resulting alignment - in a similar fashion to the constraint that hidden columns
2408 place on alignment editing (see Section \ref{lockededits} and 2) hidden
2409 columns can be used to preserve existing parts of an alignment whilst the
2410 visible parts are locally refined.
2411
2412 \subsection{Alignment Service Limits}
2413 Multiple alignment is a computationally intensive calculation. Some JABA server
2414 services and service presets only allow a certain number of sequences to be
2415 aligned. The precise number will depend on the server that you are using to
2416 perform the alignment. Should you try to submit more sequences than a service
2417 can handle, then an error message will be shown informing you of the maximum
2418 number allowed by the server.
2419
2420 \exercise{Multiple Sequence Alignment}{
2421 \label{msaex}
2422 \exstep{ Close all windows. Open the alignment at {\sf
2423 http://www.jalview.org/tutorial/unaligned.fa}.  Select {\sl
2424 Web Service $\Rightarrow$ Alignment $\Rightarrow$ Muscle with Defaults}. 
2425 A window will open giving the job status. After a short time, a second window will open
2426  with the results of the alignment.} 
2427  \exstep{Return to the first sequence alignment window by clicking on 
2428  the window, and repeat using {\sl ClustalO} (Omega) ({\sl with Defaults}), from the
2429  {\sl Web Service $\Rightarrow$ Alignment} menu, using the same initial
2430  alignment.
2431  Compare them and you should notice small differences. }
2432 \exstep{Select the last three sequences in the MAFFT alignment (you may need the scroll down the alignment), and de-align them 
2433 with {\sl Edit $\Rightarrow$ Remove All Gaps}. Press [ESC] to deselect these
2434 sequences. Then submit this view for re-alignment with {\sl ClustalO}.}
2435 \exstep{Return to the alignment window in section (c), use [CTRL]-Z (undo) to
2436 recover the alignment of the last three sequences in this MAFFT alignment.
2437 Once the ClustalO re-alignment has completed, compare the results of
2438 re-alignment of the three sequences with their alignment in the original MAFFT result.}
2439 \exstep{Select columns 60 to 125 in the original MAFFT alignment and hide them,
2440 by right clicking the mouse to bring up context menu.
2441 Select {\sl Web Service $\Rightarrow$ Alignment $\Rightarrow$ Mafft with Defaults} to 
2442 submit the visible portion of the alignment to MAFFT. When the web service job pane appears, 
2443 note that there are now two alignment job status panes shown in the window.}
2444 \exstep{When the MAFFT job has finished, compare the alignment of the N-terminal visible 
2445 region in the result with the corresponding region of the original alignment.}
2446 \exstep {If you wish, 
2447 select and hide a few more columns in the N-terminal region, and submit the alignment to the 
2448 service again and explore the effect of local alignment on the non-homologous parts of the 
2449 N-terminal region.}
2450 {\bf See the video at:
2451 \url{http://www.jalview.org/training/Training-Videos}.}
2452 }
2453
2454 \section{Customising the Parameters used for Alignment}
2455
2456 JABA web services allow you to vary the parameters used when performing a
2457 bioinformatics analysis. For JABA alignment services, this means you are
2458 usually able to modify the following types of parameters:
2459 \begin{list}{$\bullet$}{}
2460 \item{Amino acid or nucleotide substitution score matrix}
2461 \item{Gap opening and widening penalties}
2462 \item{Types of distance metric used to construct guide trees}
2463 \item{Number of rounds of re-alignment or alignment optimisation}  
2464 \end{list}
2465 \begin{figure}[htbc]
2466 \center{
2467 \includegraphics[width=3in]{images/jvaliwsparamsbox.pdf}
2468 \caption{{\bf An alignment service's parameter editing dialog box}.}
2469 \label{jwsparamsdialog} }
2470 \end{figure}
2471
2472 \subsection{Getting Help on the Parameters for a Service}
2473
2474 Each parameter available for a method usually has a short description, which
2475 Jalview will display as a tooltip, or as a text pane that can be opened under
2476 the parameter's controls. In the parameter shown in Figure
2477 \ref{clustalwparamdetail}, the description was opened by selecting the button on the left hand side.
2478
2479 \begin{figure}[htbp]
2480 \begin{center}
2481 \includegraphics[width=2.5in]{images/clustalwparamdetail.pdf}
2482 \caption{{\bf ClustalW parameter slider detail}. From the ClustalW {\sl Clustal $\Rightarrow$ Edit settings and run ...} dialog box. }
2483 \label{clustalwparamdetail}
2484 \end{center}
2485 \end{figure} 
2486
2487 \subsection{Alignment Presets}
2488 The different multiple alignment algorithms available from JABA vary greatly in
2489 the number of adjustable parameters, and it is often difficult to identify what
2490 are the best values for the sequences that you are trying to align. For these
2491 reasons, each JABA service may provide one or more presets -- which are
2492 pre-defined sets of parameters suited for particular types of alignment
2493 problem. For instance, the Muscle service provides the following presets:
2494 \begin{list}{$\bullet$}{}
2495 \item Large alignments (balanced)
2496 \item Protein alignments (fastest speed)
2497 \item Nucleotide alignments (fastest speed)
2498 \end{list}
2499
2500 The presets are displayed in the JABA web services submenu, and can also be
2501 accessed from the parameter editing dialog box, which is opened by selecting
2502 the `{\sl Edit settings and run ...}' option from the web services menu. If you have used
2503 a preset, then it will be mentioned at the beginning of the job status file shown
2504 in the web service job progress window.
2505
2506 \subsection{User Defined Presets}
2507 Jalview allows you to create your own presets for a particular service. To do
2508 this, select the `{\sl Edit settings and run ...}' option for your service,
2509 which will open a parameter editing dialog box like the one shown in Figure
2510 \ref{jwsparamsdialog}.
2511
2512 The top row of this dialog allows you to browse the existing presets, and
2513 when editing a parameter set, allows you to change its nickname. As you
2514 adjust settings, buttons will appear at the top of the parameters dialog that
2515 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
2516 description for the parameter set, which will be shown in the tooltip for the
2517 parameter set's entry in the web services menu.
2518
2519 \subsubsection{Saving Parameter Sets}
2520 When creating a custom parameter set, you will be asked for a file name to save
2521 it. The location of the file is recorded in the Jalview user preferences in the
2522 same way as a custom alignment colourscheme, so when Jalview is launched again,
2523 it will show your custom preset amongst the options available for running the
2524 JABA service.
2525
2526 %% TODO - reinstate this exercise about reinstating presets
2527
2528 % \exercise{Creating and using user defined presets}{\label{createandusepreseex}
2529 % \exstep{Import the file at
2530 % \textsf{http://www.jalview.org/tutorial/fdx\_unaligned.fa} into jalview.}
2531 % \exstep{Use the `{\slDiscover Database Ids}' function to recover the PDB cross
2532 % references for the sequences.}
2533 % \exstep{Align the sequences using the default ClustalW parameters.}
2534 % \exstep{Use the `{\sl Edit and run..}'
2535 % option to open the ClustalW parameters dialog box, and create a new preset using
2536 % the following settings:
2537 % \begin{list}{$\bullet$}{}
2538 % \item BLOSUM matrix (unchanged)
2539 % \item Gap Opening and End Gap penalties = 0.05
2540 % \item Gap Extension and Separation penalties = 0.05
2541 % \end{list}
2542
2543 % As you edit the parameters, buttons will appear on the dialog box
2544 % allowing you revert your changes or save your settings as a new parameter
2545 % set.
2546
2547 % Before you save your settings, remeber to give them a meaningful name by editing
2548 % the text box at the top of the dialog box.
2549 % }
2550 % \exstep{Repeat the alignment using your new parameter set by selecting it from
2551 % the {\sl ClustalW Presets menu}.} 
2552 % \exstep{These sequences have PDB structures associated with them, so it is
2553 % possible to compare the quality of the alignments.
2554
2555 % Use the {\sl View all {\bf N}
2556 % structures} option to calculate the superposition of 1fdn on 1fxd for both
2557 % alignments (refer to section \ref{superposestructs} for instructions). Which
2558 % alignment gives the best RMSD ? }
2559 % \exstep{Apply the same alignment parameter settings to the example alignment
2560 % (available from \textsf{http://www.jalview.org/examples/uniref50.fa}). 
2561
2562 % Are there differences ? If not, why not ?
2563 % }
2564 % }
2565
2566 %%TODO just typing a value into parameter slider doesn't actually modify value, return needs to be hit. This is not intuitive (these days) - loss of focus should update values of parameters (e.g. when the run/start job button is hit)
2567
2568 \section{Protein Alignment Conservation Analysis}
2569 \label{aacons}
2570 The {\sl Web Service $\Rightarrow$ Conservation} menu controls the computation
2571 of over 17 different amino acid conservation measures for the current alignment
2572 view. The JABAWS AACon Alignment Conservation Calculation Service, which is used
2573 to calculate these scores, provides a variety of standard measures described by
2574 Valdar in 2002\footnote{Scoring residue conservation. Valdar (2002) {\sl
2575 Proteins: Structure, Function, and Genetics} {\bf 43} 227-241.} as well as an efficient implementation of the SMERFs
2576 score developed by Manning et al. in 2008.\footnote{SMERFS Score Manning et al. {\sl BMC
2577 Bioinformatics} 2008, {\bf 9} 51 \href{http://dx.doi.org/10.1186/1471-2105-9-51}{doi:10.1186/1471-2105-9-51}}
2578
2579 \subsection{Enabling and Disabling AACon Calculations}
2580 When the AACon Calculation entry in the {\sl Web Service $\Rightarrow$
2581 Conservation} menu is ticked, AACon calculations will be performed every time
2582 the alignment is modified. Selecting the menu item will enable or disable
2583 automatic recalculation.
2584
2585 \subsection{Configuring which AACon Calculations are Performed}
2586 The {\sl Web Service $\Rightarrow$ Conservation $\Rightarrow$ Change AACon
2587 Settings ...} menu entry will open a web services parameter dialog for the
2588 currently configured AACon server. Standard presets are provided for quick and
2589 more expensive conservation calculations, and parameters are also provided to
2590 change the way that SMERFS calculations are performed.
2591 AACon settings for an alignment are saved in Jalview projects along with the
2592 latest calculation results.
2593
2594 \subsection{Changing the Server used for AACon Calculations}
2595 If you are working with alignments too large to analyse with the public JABAWS
2596 server, then you will most likely have already configured additional JABAWS
2597 servers. By default, Jalview will chose the first AACon service available from
2598 the list of JABAWS servers available. You can change the AACon services by 
2599 selecting it from the {\sl Web Service $\Rightarrow$
2600 Conservation $\Rightarrow$ Change AACon Settings} submenu.
2601 Alternatively to add new service, go to the desktop window menu and select {\sl Tools $\Rightarrow$
2602 Preferences $\Rightarrow$ Web Services tab} and add {\sl New Services URL}, then use the {\sl move up} or {\sl move down} buttons 
2603 to reorder the services.
2604
2605
2606 \chapter{Analysis of Alignments}
2607 \label{alignanalysis}
2608 Jalview provides support for sequence analysis in two ways. A number of
2609 analytical methods are `built-in', these are accessed from the {\sl Calculate}
2610 alignment window menu. Computationally intensive analyses are run outside
2611 Jalview {\sl via} web services - and found under the
2612 {\sl Web Service} menu. In this section, we describe the built-in analysis
2613 capabilities common to both the Jalview Desktop and the JalviewJS.
2614  
2615 \section{PCA}
2616 Principal components analysis calculations create a spatial
2617 representation of the similarities within the current selection or the whole alignment if no selection has been made. After
2618 the calculation finishes, a 3D viewer displays each sequence as a point in
2619 3D `similarity space'. Sets of similar sequences tend to lie near each other in
2620 this space.
2621 Note: The calculation is computationally expensive, and may fail for very large
2622 sets of sequences - because the JVM has run out of memory. Memory issues, and
2623 how to overcome them, were discussed in Section \ref{memorylimits}.
2624
2625 \subsubsection{What is PCA?}
2626 Principal components analysis is a technique for examining the structure of
2627 complex data sets. The components are a set of dimensions formed from the
2628 measured values in the data set, and the principal component is the one with the
2629 greatest magnitude, or length. The sets of measurements that differ the most
2630 should lie at either end of this principal axis, and the other axes correspond
2631 to less extreme patterns of variation in the data set.
2632 In this case, the components are generated by an eigenvector decomposition of
2633 the matrix formed from the sum of pairwise substitution scores at each aligned
2634 position between each pair of sequences. The basic method is described in the
2635 1995 paper by {\sl G. Casari, C. Sander} and {\sl A. Valencia} \footnote{{\sl
2636 Nature Structural Biology} (1995) {\bf 2}, 171-8.
2637 PMID: 7749921} and implemented at the SeqSpace server at the EBI.\footnote{See \url{http://www.jalview.org/help/html/calculations/pca.html}.}
2638
2639 % Jalview provides two different options for the PCA calculation: SeqSpace and
2640 % Jalview mode. In SeqSpace mode, PCAs are computed using the identity matrix, and
2641 % gaps are treated as 'the unknown residue' (this actually differs from the
2642 % original SeqSpace paper, and will be adjusted in a future version of Jalview).
2643 % In Jalview mode, PCAs are computed using the chosen score matrix - which for
2644 % protein sequences, defaults to BLOSUM 62, and for nucleotides, is the
2645 % DNA identity matrix that also treats Us and Ts as identical, to support analysis
2646 % of both RNA and DNA alignments.
2647
2648 \subsubsection{The PCA Viewer}
2649
2650 PCA analysis can be launched from the {\sl Calculate $\Rightarrow$ Tree or PCA} menu option. 
2651 {\bf PCA requires a selection containing at
2652 least 4 sequences}.  In the Choose Calculation window, select the {\sl Principal Components Analysis} button and then select {\sl Calculate} 
2653 (Figure \ref{PCA}).
2654 Each sequence is represented by a small square, coloured by the background
2655 colour of the sequence ID label. The axes can be rotated by clicking and
2656 dragging the left mouse button and zoomed using the $\uparrow$ and $\downarrow$
2657 keys or the scroll wheel of the mouse (if available).  A tool tip appears if the
2658 cursor is placed over a sequence. Sequences can be selected by clicking on them.
2659 [CTRL]-Click can be used to select multiple sequences.
2660
2661 Labels will be shown for each sequence by toggling the {\sl View $\Rightarrow$
2662 Show labels} menu option, and the plot background colour changed {\sl via} the
2663 {\sl View $\Rightarrow$ Background Colour..} dialog box. A graphical
2664 representation of the PCA plot can be exported as an EPS or PNG image {\sl via}
2665 the {\sl File $\Rightarrow$ Save as $\Rightarrow$ \ldots } submenu.
2666
2667 \exercise{Principal Component Analysis}
2668 {\label{pcaex}
2669 \exstep{Load the alignment at
2670 \textsf{http://www.jalview.org/tutorial/alignment.fa}.}
2671 \exstep{Select the menu option {\sl Calculate $\Rightarrow$ Tree or PCA..}.  in the alignment
2672 window and a dialogue box will open. Select the Principal Component Analysis option
2673 and then click the Calculate button.} 
2674 \exstep{Move
2675 this window within the desktop so that the alignment and PCA viewer windows are visible.
2676 Try rotating the plot by clicking and dragging the mouse on the plot in the PCA window.
2677 Note that clicking on points in the plot will highlight the sequences on the
2678 alignment.}
2679 \exstep{Use the [ESC] key to deselect sequence selection.
2680 Select {\sl Calculate $\Rightarrow$ Tree or PCA..}. in the alignment window. In dialogue box select Neighbour
2681 Joining and in the drop-down list select BLOSUM62. Click the Calculate button
2682 and a tree window will open.}
2683 \exstep{Place the mouse cursor on the tree so that the
2684 tree partition divides the tree into a number of groups, each with a
2685 different (arbitrarily selected) colour.
2686 Note how the colour of the sequence ID label matches both the colour of
2687 the partitioned tree and the points in the PCA plot.} 
2688 {\bf See the video at:
2689 \url{http://www.jalview.org/training/Training-Videos}.}
2690 }
2691
2692 \begin{figure}[hbtp]
2693 \begin{center}
2694 \includegraphics[width=2in]{images/PCA1.pdf}
2695 \includegraphics[width=3in]{images/PCA3.pdf}
2696 \caption{{\bf PCA Analysis.} }
2697 \label{PCA}
2698 \end{center}
2699 \end{figure}
2700
2701
2702
2703 \subsubsection{PCA Data Export}
2704 Although the PCA viewer supports export of the current view, the plots produced
2705 are rarely suitable for direct publication. The PCA viewer's {\sl File} menu
2706 includes a number of options for exporting the PCA matrix and transformed points
2707 as comma separated value (CSV) files. These files can be imported by tools such
2708 as {\bf R} or {\bf gnuplot} in order to graph the data.
2709
2710 \section{Trees}
2711 \label{trees}
2712
2713 Jalview can calculate and display trees, providing interactive tree-based
2714 grouping of sequences though a tree viewer. All trees are calculated {\sl via}
2715 the {\sl Calculate $\Rightarrow$ Tree or PCA \ldots} menu option.
2716 Trees can be calculated from distance matrices determined from \% identity or
2717 aggregate BLOSUM 62 score using either {\sl Average Distance} (UPGMA) or {\sl
2718 Neighbour Joining} algorithms. The input data for a tree is either the selected
2719 region or the whole alignment, excluding any hidden regions.
2720
2721 On calculating a tree, a new window opens (Figure \ref{trees1}) which contains
2722 the tree. Various display settings can be found in the tree window {\sl View}
2723 menu, including font, scaling and label display options. The {\sl File
2724 $\Rightarrow$ Save As} submenu contains options for image and Newick file
2725 export. Newick format is a standard file format for trees which allows them to
2726 be exported to other programs.  Jalview can also read in external trees in
2727 Newick format {\sl via} the {\sl File $\Rightarrow$ Load Associated Tree} menu
2728 option. Leaf names on imported trees will be matched to the associated alignment
2729 - unmatched leaves will still be displayed, and can be highlighted using the
2730 {\sl View $\Rightarrow$ Mark Unlinked Leaves} menu option.
2731
2732
2733
2734 \begin{figure}
2735 \begin{center}
2736 \includegraphics[width=2.5in]{images/trees1.pdf}
2737 \includegraphics[width=2.5in]{images/trees2.pdf}
2738 \includegraphics[width=1.25in]{images/trees4.pdf}
2739 \caption{{\bf Calculating Trees} Jalview provides a range of options 
2740 for calculating trees.
2741 Jalview can also load precalculated trees in Newick format (right).}
2742 \label{trees1}
2743 \end{center}
2744 \end{figure}
2745
2746 \begin{figure}
2747 \begin{center}
2748 \includegraphics[width=5in]{images/trees3.pdf}
2749 \caption{{\bf Interactive Trees} The tree level cutoff can be used to designate
2750 groups in Jalview.}
2751 \label{trees2}
2752 \end{center}
2753 \end{figure}
2754
2755 Clicking on the tree brings up a cursor across the height of the tree. The
2756 sequences are automatically partitioned and coloured (Figure \ref{trees2}). To
2757 group them together, select the {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$
2758 By Tree Order $\Rightarrow$ \ldots} alignment window menu option and choose the
2759 correct tree. The sequences will then be sorted according to the leaf order
2760 currently shown in the tree view. The coloured background to the sequence IDs
2761 can be removed with {\sl Select $\Rightarrow$ Undefine Groups} from the
2762 alignment window menu. Note that tree partitioning will also remove any groups
2763 and colourschemes on a view, so create a new view ([CTRL-T]) if you wish to
2764 preserve these.
2765
2766
2767 \exercise{Trees}
2768 {\label{treeex}
2769
2770 \exstep{Open the alignment at
2771 \textsf{http://www.jalview.org/tutorial/alignment.fa}.}
2772
2773 \exstep{Select {\sl Calculate $\Rightarrow$ Tree or PCA..}. in the alignment
2774 window menu and a dialogue box opens. In the tree section select Neighbour
2775 Joining, in the drop-down list select BLOSUM62 and click the Calculate
2776 button. A tree window will open.}
2777
2778 \exstep{Click on the
2779 tree window, a cursor will appear as a vertical line. Note that clicking will
2780 place this cursor, and divides the tree into a number of groups, each highlighted
2781 with a different colour. Place the cursor to give about 4 groups.}
2782
2783 \exstep{Place the mouse cursor on a node of the tree to open a tool tip. Double click the node to invert the leaves.
2784 }
2785
2786 \exstep{In the tree window, select {\sl View $\Rightarrow$ Sort Alignment
2787 by Tree}. The sequences are reordered to match the order in the tree and groups 
2788  are formed implicitly. Alternatively in the alignment window, select
2789 {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$ By Tree Order $\Rightarrow$
2790  Neighbour Joining Tree using BLOSUM62 from...}.}
2791
2792 \exstep{Select {\sl Calculate $\Rightarrow$ Tree or PCA..}. in the alignment
2793 window. In the dialogue box, select Average Distance and in the drop down
2794 list select BLOSUM62. Click the Calculate button and a new
2795 tree window will appear. The group colouring makes it easy to see the differences between the two
2796 trees calculated by the different methods.}
2797
2798 \exstep{With no groups selected in the alignment window, select sequence 2 from
2799 column 60 to sequence 12 and column 123. Select {\sl Calculate $\Rightarrow$
2800 Tree or PCA..}. , in the dialogue box select Neighbour Joining and
2801 BLOSUM62, then click the Calculate button.
2802  A tree will appear containing 11 sequences. It has been coloured
2803  according to the already selected groups from the first tree and is calculated purely from the residues
2804  in the selection.}
2805
2806 Comparing the location of individual sequences between the three trees illustrates the importance of selecting appropriate regions of the 
2807 alignment for the calculation of trees.
2808
2809 {\bf See the video at:
2810 \url{http://www.jalview.org/training/Training-Videos}.}
2811
2812 }
2813
2814 %\subsubsection{Multiple Views and Input Data recovery from PCA and Tree Viewers}
2815 % move to ch. 3 ?
2816 %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.
2817
2818 \subsubsection{Recovering input data for a Tree or PCA Plot Calculation}
2819 \parbox[c]{5in}{
2820 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. 
2821 }
2822 \parbox[c]{1.25in}{\centerline{\includegraphics[width=1.25in]{images/pca_fmenu.pdf}
2823 }}
2824
2825 \subsubsection{Changing the associated view for a Tree or PCA Viewer}
2826 \parbox[c]{4in}{
2827 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. 
2828 } \parbox[c]{3in}{\centerline{
2829 \includegraphics[width=2.5in]{images/pca_vmenu.pdf} }}
2830
2831 \subsection{Tree Based Conservation Analysis}
2832 \label{treeconsanaly}
2833
2834 Trees reflect the pattern of global sequence similarity exhibited by the
2835 alignment, or region within the alignment, that was used for their calculation.
2836 The Jalview tree viewer enables sequences to be partitioned into groups based
2837 on the tree. This is done by clicking within the tree viewer window. Once subdivided, the
2838 conservation between and within groups can be visually compared in order to
2839 better understand the pattern of similarity revealed by the tree and the
2840 variation within the clades partitioned by the grouping. The conservation based
2841 colourschemes and the group associated conservation and consensus annotation
2842 (enabled using the alignment window's {\sl Annotations $\Rightarrow$ Autocalculated
2843 Annotation $\Rightarrow$ Group Conservation} and {\sl Group Consensus} options)
2844 can help when working with larger alignments.
2845
2846
2847
2848
2849 %\exercise{Pad Gaps in an Alignment}{
2850 %\exstep{Open the alignment at
2851 % \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
2852 %alignment.}
2853 %\exstep{Select {\sl Calculate $\Rightarrow$ Calculate Tree $\Rightarrow$
2854 %Neighbour Joining Using BLOSUM62}.
2855
2856 %A warning dialog box {\bf ``Sequences not aligned'' } appears because the
2857 % sequences input to the tree calculation are of different lengths. }
2858
2859 %\exstep{Select {\sl Edit $\Rightarrow$ tick Pad Gaps } and perform the
2860 %tree calculation again. This time a new tree should appear - because padding
2861 %gaps ensures all the sequences are the same length after editing.}
2862 %{\sl Pad Gaps } option
2863 %can be set in Preferences using
2864 %{\sl Tool $\Rightarrow$ Preference $\Rightarrow$ Editing}.
2865
2866 %{\bf See the video at:
2867 %\url{http://www.jalview.org/training/Training-Videos}.}
2868 %}
2869
2870  \exercise{Tree Based Conservation Analysis}{
2871 \label{consanalyexerc}
2872 \exstep{Load the PF03460 PFAM seed alignment using the sequence fetcher. 
2873 Select {\sl Colour $\Rightarrow$ Taylor $\Rightarrow$ By Conservation}, set
2874  {\sl Conservation} shading threshold at around 20. }
2875  \exstep{Build a Neighbour joining tree by selecting {\sl Calculate
2876  $\Rightarrow$ Tree or PCA..}. in the alignment window. In the dialogue box, select Neighbour
2877 Joining and in the drop-down
2878 list select BLOSUM62, then click the Calculate button.}
2879 \exstep{Use the cursor to select a point on the tree to partition the
2880 alignment into groups.}
2881 \exstep {Select {\sl View $\Rightarrow$ Sort Alignment By Tree} option in the
2882 tree window to re-order the sequences in the alignment.
2883 Examine the variation in colouring between different groups of sequences in the
2884  alignment window. }
2885 \exstep {You may find it easier to browse the alignment if you first uncheck
2886  the {\sl Annotations $\Rightarrow$ Show Annotations} option. Open the
2887 Overview Window from the View menu to aid navigation.}
2888
2889 \exstep{Try changing the colourscheme of the residues in the alignment to
2890 BLOSUM62 (whilst ensuring that {\sl Apply Colour to All Groups} is selected).}
2891 {\sl Note: You may want to save the alignment and tree as a project file, since
2892 it is used in the next set of exercises. }
2893
2894 {\bf See the video at:
2895 \url{http://www.jalview.org/training/Training-Videos}.}
2896 }
2897
2898
2899 \subsection{Redundancy Removal}
2900
2901 The redundancy removal dialog box is opened using the {\sl Edit $\Rightarrow$ Remove Redundancy\ldots} option 
2902 in the alignment menu. As its menu option placement suggests, this is actually an alignment editing function, 
2903 but it is convenient to describe it here. The redundancy removal dialog box presents a percentage identity 
2904 slider which sets the redundancy threshold. Aligned sequences which exhibit a percentage identity greater 
2905 than the current threshold are highlighted in black. The [Remove] button can then be used to delete these 
2906 sequences from the alignment as an edit operation.
2907 \begin{figure}
2908 \begin{center}
2909 \includegraphics[width=5.5in]{images/redundancy.pdf}
2910 \end{center}
2911 \label{removeredundancydialog}
2912 \caption{The Redundancy Removal dialog box opened from the edit menu. Sequences that exceed the current percentage identity 
2913 threshold and are to be removed are highlighted in black.}
2914 \end{figure}
2915
2916
2917 \subsection{Subdividing the Alignment According to Specific Mutations}
2918
2919 It is often necessary to explore variations in an alignment that may correlate
2920 with mutations observed in a particular region; for example, sites exhibiting
2921 single nucleotide polymorphism, or residues involved in substrate recognition in
2922 an enzyme. One way to do this would be to calculate a tree using the specific
2923 region, and subdivide it in order to partition the alignment.
2924 However, calculating a tree can be slow for large alignments, and the tree may
2925 be difficult to partition when complex mutation patterns are being analysed. The
2926 {\sl Select $\Rightarrow$ Make groups for selection } function was introduced to
2927 make this kind of analysis easier. When selected, it will use the characters in
2928 the currently selected region to subdivide the alignment. For example, if a
2929 single column is selected, then the alignment (or each group defined on the
2930 alignment) will be divided into groups based on the residue or nucleotide found
2931 at that position. These new groups are annotated with the characters in the
2932 selected region, and Jalview's group based conservation analysis annotation and
2933 colourschemes can then be used to reveal any associated pattern of sequence
2934 variation across the whole alignment.
2935
2936
2937 % These annotations can be hidden and deleted via the context menu linked to the
2938 % annotation row; but they are only created on loading an alignment. If they are
2939 % deleted then the alignment should be saved and then reloaded to restore them.
2940 % Jalview provides a toggle to autocalculate a consensus sequence upon editing.
2941 % This is normally selected by default, but can be turned off for large alignments {\sl via} the {\sl Calculate $\Rightarrow$ Autocalculate
2942 % Consensus} menu option if the interface is too slow.
2943
2944 % \subsubsection{Group Associated Annotation}
2945 % \label{groupassocannotation}
2946 % Group associated consensus and conservation annotation rows reflect the
2947 % sequence variation within a particular group. Their calculation is enabled
2948 % by selecting the {\sl Group Conservation} or {\sl Group Consensus} options in
2949 % the {\sl Annotation $\Rightarrow$ Autocalculated Annotation } submenu of the
2950 % alignment window. 
2951
2952 % \subsubsection{Alignment and Group Sequence Logos}
2953 % \label{seqlogos}
2954
2955 % The consensus annotation row that is shown below the alignment can be overlaid
2956 % with a sequence logo that reflects the symbol distribution at each column of
2957 % the alignment. Right click on the Consensus annotation row and select the {\sl
2958 % Show Logo} option to display the Consensus profile for the group or alignment.
2959 % Sequence logos can be enabled by default for all new alignments {\sl via} the
2960 % Visual tab in the Jalview desktop's preferences dialog box.
2961
2962 \section{Pairwise Alignments}
2963 Jalview can calculate optimal pairwise alignments between arbitrary 
2964 sequences {\sl via} the {\sl Calculate $\Rightarrow$ Pairwise Alignments\ldots} menu option. 
2965 Global alignments of all pairwise combinations of the selected sequences are performed and the results returned in a text box.
2966
2967
2968
2969 \exercise{Remove Redundant Sequences}{
2970 \label{redundantex}
2971 \exstep{Using the alignment generated in the previous exercise (exercise
2972 \ref{consanalyexerc}).
2973 In the alignment window, you may need to deselect groups using Esc key.}
2974
2975 \exstep{In the {\sl Edit} menu select {\sl Remove Redundancy} to open the
2976 Redundancy threshold selection dialog. Adjust the redundancy threshold value, start
2977 at 50 and increase the value to 65. Sequences selected will change colour in the Sequence ID panel. Select ``Remove'' to
2978 remove the sequences that are more than 65\% similar under this alignment.}
2979
2980 \exstep{From the tree window, select {\sl View $\Rightarrow$
2981 Mark Unlinked Leaves} option, and note that the removed sequences are now prefixed with a * in the tree view.}
2982  \exstep{Use the [Undo] button in the Redundancy threshold selection dialog box
2983 to recover the sequences. Note that the * symbols disappear from the tree display.}
2984 \exstep{Experiment with the redundancy removal and observe the relationship between the percentage identity threshold and 
2985 the pattern of unlinked nodes in the tree display.}
2986 }
2987
2988 \exercise{Group Conservation Analysis}{
2989 \label{conservationex}
2990 \exstep{Re-use or recreate the alignment and tree which you worked with in the
2991 tree based conservation analysis exercise (exercise \ref{consanalyexerc}).} 
2992 \exstep{In the {\sl View} menu in the alignment window, select {\sl New View} to
2993 create a new view. Ensure the annotation panel is displayed ({\sl Annotations $\Rightarrow$ Show Annotations} is toggled on). Enable the
2994 display of {\sl Group Consensus} option by checking {\sl Group Consensus} in the {\sl Annotation $\Rightarrow$
2995 Autocalculated Annotation $\Rightarrow$
2996 Group Consensus} submenu.}
2997
2998 \exstep{Displaying the sequence 
2999 logos will make it easier to see the different residue populations within each
3000 group. Activate the logo by right clicking the name of the Consensus annotation to
3001 open the context menu and select the {\sl Show Logo} option. Alter its size, by moving the cursor onto the annotation row, right clicking the 
3002 mouse and dragging it up. Alter its position, by right clicking the name of the Consensus annotation 
3003 and dragging it up to the top of the annotations.} 
3004 \exstep{In the column alignment ruler, select a column exhibiting with about 50\%
3005   of its residues conserved ({\em ie. about 50\% in the consensus histogram})
3006   that lies within the central conserved region of the alignment.
3007 (Column 74 is used in \href{https://youtu.be/m-PjynicXRg}{the Tree video}).} 
3008 \exstep{Subdivide the alignment
3009 according to this selection using {\sl Select $\Rightarrow$ Make Groups for Selection}.}
3010 \exstep{Re-order the alignment according to the new groups that have been
3011 defined by selecting {\sl Calculate $\Rightarrow$ Sort $\Rightarrow$
3012 By Group}.
3013 Click on the group annotation row IDs to select groups exhibiting a
3014 specific mutation.}
3015 \exstep{Select another column exhibiting about 50\% conservation
3016 overall, and subdivide the alignment further. Note that the new groups
3017 inherit the names of the original groups, allowing you to identify the
3018 combination of mutations that resulted in the subdivision.}
3019 \exstep{Clear the groups, and try to subdivide the alignment using two
3020 non-adjacent columns.
3021
3022 {\sl Hint: You may need to hide the intervening columns before you can select
3023 both of the columns that you wish to use to subdivide the alignment.}}
3024 \exstep{Switch back to the original view, and experiment with subdividing
3025 the tree groups made in the previous exercise.}
3026 {\bf See the video at:
3027 \url{http://www.jalview.org/training/Training-Videos}.}
3028 }
3029
3030 \begin{figure}[]
3031 \begin{center}
3032 \includegraphics[width=4in]{images/pairwise.pdf}
3033 \caption{{\bf Pairwise alignment of sequences.} Pairwise alignments of three selected sequences are shown in a textbox.}
3034 \label{pairwise}
3035 \end{center}
3036 \end{figure}
3037
3038
3039 % To review, Chapter \ref{featannot} describes the mechanisms provided by
3040 % Jalview for interactive creation of sequence and alignment annotation, and how
3041 % they can be displayed, imported and exported and used to reorder the alignment. Chapter
3042 % \ref{featuresfromdb} discusses the retrieval of database references and
3043 % establishment of sequence coordinate systems for the retrieval and display of
3044 % features from databases and DAS annotation services.
3045 % Chapter \ref{msaservices} describes how to use the range of multiple alignment
3046 % programs provided by JABAWS, and Chapter \ref{aacons} introduces JABAWS AACon
3047 % service for protein multiple alignment conservation analysis.
3048 %  In Chapter \ref{alignanalysis}, you will find
3049 % descriptions and exercises on building and displaying trees, PCA analysis,
3050 % alignment redundancy removal, pairwise alignments and alignment conservation
3051 % analysis. 
3052 % Chapter \ref{wkwithstructure} introduces the structure visualization
3053 % capabilities of Jalview.
3054 % Chapter \ref{protsspredservices} explains how to perform protein secondary
3055 % structure predictions with JPred, and JABAWS protein disorder prediction
3056 % services are introduced in Chapter \ref{protdisorderpred}.
3057 % Chapter \ref{workingwithnuc} describes functions and visualization techniques
3058 % relevant to working with nucleotide sequences, coding region annotation and nucleotide
3059 % sequence alignments.
3060 % Chapter \ref{jvwebservices} introduces the various web based services
3061 % available to Jalview users, and Chapter \ref{jabaservices} explains how to
3062 % configure the Jalview Desktop for access to new JABAWS servers.
3063
3064
3065 % and Section \ref{workingwithrna} covers the visualization,
3066 % editing and analysis of RNA secondary structure.
3067
3068 \chapter{Working with 3D structures}
3069 \label{3Dstructure}
3070 \label{wkwithstructure}
3071 Jalview facilitates the use of 3D structure data for the analysis of alignments
3072 by providing a linked view of structures associated with the aligned sequences.
3073 It also allows sequence, secondary structure and B-factor data to be imported
3074 from structure files, and supports the use of the EMBL-EBI's SIFTS database to
3075 construct accurate mappings between UniProt protein sequences and structures
3076 retrieved from the PDB.
3077
3078 \section{Molecular graphics systems supported by Jalview}
3079 Jalview can interactively view 3D structure using Jmol, a Java based molecular
3080 viewing program\footnote{See the Jmol homepage \url{http://www.jmol.org} for
3081 more information.} integrated with Jalview.\footnote{Earlier
3082 versions of Jalview included MCView - a simple main chain structure viewer.
3083 Structures are visualized as an alpha carbon trace and can be viewed, rotated
3084 and coloured using the sequence alignment.} It also supports the use of UCSF
3085 Chimera, a powerful molecular graphics system that needs separate installation.
3086 Jalview can also read PDB and mmCIF format files directly to extract sequences
3087 and secondary structure information, and retrieve records from the European
3088 Protein Databank (PDBe) using the Sequence Fetcher (see \ref{fetchseq}).
3089
3090 \subsection{Configuring the default structure viewer}
3091 \label{configuring3dviewer}
3092 To configure which viewer is used when creating a new
3093 structure view, open the Structures preferences window {\sl via} {\sl Tools $\Rightarrow$ Preferences\ldots} and
3094 select either JMOL or CHIMERA as the default viewer. If you select Chimera,
3095 Jalview will search for the installed program, and if it cannot be found,
3096 you will be prompted to locate the Chimera binary, or alternately, open the UCSF
3097 Chimera download page to obtain the software.
3098
3099 \section{Automatic Association of PDB Structures with Sequences}
3100 Jalview will attempt to automatically determine which structures are associated
3101 with a sequence via its ID, and any associated database references. To do this
3102 for a particular sequence or the current selection, open the Sequence ID popup
3103 menu and select {\sl View 3D Structure}, to open the 3D Structure Chooser. 
3104 %(Figure\ref{auto}). 
3105
3106 When the structure chooser is first opened, if no database identifiers are
3107 available, Jalview will automatically perform a database reference
3108 retrieval (See \ref{fetchdbrefs}) to discover identifiers for the
3109 sequences to use to search the PDB. This can take a
3110 few seconds for each sequence and will be performed for all selected
3111 sequences.\footnote{After this is done, you can see the added database
3112 references in a tool tip by mousing over the sequence ID. You can use the {\sl
3113 View $\Rightarrow$ Sequence ID Tooltip $\Rightarrow$ Show Db References }
3114 submenu option to enable or disable these data in the tooltip.}
3115
3116 Once the retrieval has finished, the structure chooser dialog will show any
3117 available PDB entries for the selected sequences.
3118
3119
3120 % \begin{figure}[htbp]
3121 % \begin{center}
3122 % %TODO fix formatting
3123 % \begin{center} 
3124 % \includegraphics[width=3.5in]{images/pdbstructurechooser.pdf}
3125 % \end{center}
3126
3127
3128 % \caption{{\bf The PDB Structure Chooser dialog.} }
3129 % \label{auto}
3130 % \end{center}
3131 % \end{figure}
3132
3133 \subsection{Drag-and-Drop Association of PDB Files with Sequences by Filename
3134 Match}
3135 \label{multipdbfileassoc}
3136 If you have PDB files stored on your computer {\bf named the same way as the
3137 sequences in the alignment}, then you can drag them from their location on the
3138 file browser onto an alignment window. Jalview will search the alignment for
3139 sequences with IDs that match any of the files, and offer a dialog like the one
3140 in Figure \ref{multipdbfileassocfig}.
3141
3142 If no associations are made, then sequences extracted
3143 from the structure will be simply added to the alignment. However, if only
3144 some of the PDB files are associated, Jalview will raise another dialog box
3145 giving you the option to add any remaining sequences from the PDB structure files not present in
3146 the alignment. This allows you to easily decorate sequences in a newly imported
3147 alignment with any corresponding structures you've already collected in a directory
3148 accessible from your computer.\footnote{We plan to extend this facility in
3149 future so Jalview will automatically search for PDB files matching your
3150 sequence within a local directory. Check out 
3151 \href{http://issues.jalview.org/browse/JAL-801}{Jalview issue 801}}
3152
3153 After associating sequences with PDB files, you can view the PDB structures by
3154 opening the Sequence ID popup
3155 menu and selecting {\sl View 3D Structure}. The PDB files you loaded will be
3156 shown in the {\bf Cached Structures} view, after selecting it from the drop down
3157 menu in the dialog box. 
3158
3159 % 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 ...
3160 % JBP: yes there is - under 'Discovery of ' subsection.
3161 \begin{figure}[htbp]
3162 \begin{center}
3163 \includegraphics[]{images/pdbdragdropassoc.pdf}
3164
3165 \caption{{\bf Associating PDB files with sequences by drag-and-drop.} Dragging
3166 PDB files onto an alignment of sequences with names matching the dragged files
3167 names (A), results in a dialog box (B) that gives the option to associate each
3168 file with any sequences with matching IDs. }
3169 \label{multipdbfileassocfig}
3170 \end{center}
3171 \end{figure}
3172
3173
3174 \section{Viewing Structures}
3175 \label{structurechooser}
3176 The structure viewer is launched via the Sequence ID context
3177 menu. To view structures associated with a sequence or a selected set of
3178 sequences in the alignment, simply right click the mouse to open the context
3179 menu, and select {\sl 3D Structure data \ldots} to open the Structure Chooser
3180 dialog box. 
3181
3182 If any of
3183 the {\bf currently selected} sequences have structures in the PDB, 
3184 they will appear in the Structure Chooser dialog box. The structures can be ranked by
3185 different parameters, but are by default ordered according to their PDB
3186 quality score. 
3187
3188 To view one or more structures, simply click {\sl
3189 View} to open a structure viewer containing the structures selected in the
3190 dialog. If several structures were picked, these will be shown
3191 superposed according to the alignment.
3192 You may find Jalview has already picked the best structure - using one of the
3193 criteria shown in the dropdown menu (e.g. 'Best Quality', which is picked by
3194 default). However, you are free to select your own.
3195
3196 The structure(s) to be displayed will be downloaded or loaded from
3197 the local file system, and shown as a ribbon diagram coloured according to the
3198 associated sequence in the current alignment view (Figure \ref{structure}). The structure can be rotated by clicking and dragging in the structure
3199 window. The structure can be zoomed using the mouse scroll wheel or by
3200 [SHIFT]-dragging the structure.
3201
3202 Moving the mouse cursor over a sequence to which the structure is linked in the
3203 alignment view highlights the respective residue's sidechain atoms. The
3204 sidechain highlight may be obscured by other parts of the molecule. Similarly,
3205 moving the cursor over the structure shows a tooltip and highlights the
3206 corresponding residue in the alignment. Clicking the alpha carbon or phosphorous
3207 backbone atom will toggle the highlight and residue label on and off. Often, the
3208 position highlighted in the sequence may not be in the visible portion of the
3209 current alignment view and the sliders will scroll automatically to show the
3210 position. If the alignment window's {\sl View $\Rightarrow$ Automatic Scrolling
3211 } option is not selected, however, then the automatic adjustment will be
3212 disabled for the current view.
3213
3214 \begin{figure}[htbp]
3215 \begin{center}
3216 \parbox{4in}{
3217 {\centering 
3218 \begin{center}
3219 \includegraphics[width=4in]{images/structure1.pdf}
3220 \end{center}
3221 }
3222 }
3223 \parbox{2.2in}{
3224 {\centering 
3225 \begin{center}
3226 \includegraphics[width=2.2in]{images/structure2.pdf}
3227 \end{center}
3228 }
3229 }
3230 \caption{{\bf Structure visualization} Structure viewers are launched from
3231 the 3D Structure chooser dialog (left). Jalview shows the displayed structures
3232 coloured according the alignment view (right). }
3233 \label{structure}
3234 \end{center}
3235 \end{figure}
3236
3237 \subsection{Customising Structure Display}
3238
3239 Structure display can be modified using the {\sl Colour} and {\sl View} menus
3240 in the structure viewer. The background colour can be modified by selecting the
3241 {\sl Colours $\Rightarrow$ Background Colour\ldots} option.
3242
3243 By default, the structure will be coloured in the same way as the associated
3244 sequence(s) in the alignment view from which it was launched. The structure can
3245 be coloured independently of the sequence by selecting an appropriate colour
3246 scheme from the {\sl Colours} menu. It can be coloured according to the
3247 alignment using the {\sl Colours $\Rightarrow$ By Sequence } option. The image
3248 in the structure viewer can be saved as an EPS or PNG with the {\sl File
3249 $\Rightarrow$ Save As $\Rightarrow$ \ldots} submenu, which also allows the raw
3250 data to be saved as PDB format. The mapping between the structure and the
3251 sequence (how well and which parts of the structure relate to the sequence) can
3252 be viewed with the {\sl File $\Rightarrow$ View Mapping} menu option.
3253
3254 \subsubsection{Using the Jmol Visualization Interface }
3255
3256 Jmol has a comprehensive set of selection and visualization functions that are
3257 accessed from the Jmol popup menu (by right-clicking in the Jmol window or by
3258 clicking the Jmol logo). Molecule colour and rendering style can be manipulated,
3259 and distance measurements and molecular surfaces can be added to the view. It
3260 also has its own ``Rasmol\footnote{See \url{http://www.rasmol.org}}-like'' scripting
3261 language, which is described elsewhere\footnote{Jmol Wiki:
3262 \url{http://wiki.jmol.org/index.php/Scripting}
3263
3264 Jmol Scripting reference:
3265 \url{http://www.stolaf.edu/academics/chemapps/jmol/docs/}}. Jalview utilises the
3266 scripting language to interact with Jmol and to store the state of a Jmol
3267 visualization within Jalview archives, in addition to the PDB data file
3268 originally loaded or retrieved by Jalview. To access the Jmol scripting
3269 environment directly, use the {\sl Jmol $\Rightarrow$ Console} menu option.
3270
3271 If you would prefer to use Jmol to manage structure colours, then select the
3272 {\sl Colours $\Rightarrow$ Colour with Jmol} option. This will disable any
3273 automatic application of colour schemes when new structure data is added, or
3274 when associated alignment views are modified.
3275
3276 %%TODO: no mapping when using N&W alg.
3277
3278 \exercise{Viewing Structures with the integrated Jmol Viewer}{
3279 \label{viewingstructex}
3280 \exstep{Load the alignment at
3281 \textsf{http://www.jalview.org/examples/exampleFile.jvp}.}
3282 \exstep{Right-click on the
3283 sequence ID label of {\sl FER1\_SPIOL} to open
3284 the ID popup menu and select {\sl 3D Structure Data}. After a short pause, a
3285 Structure Chooser dialog will open for the sequence, listing available
3286 structure data from the PDB. Select { \sl 1a70} from the list and click {\sl
3287 New View}.
3288
3289 {\sl Note:} The Structure Chooser dialog presents available PDB structures
3290 by querying the EMBL-EBI's PDBe web API. Extra information can be
3291 including in this window by checking boxes in the columns of the {\sl Customise Displayed Options} tab.
3292 % JBP Note: Bug JAL-1238 needs to be fixed ASAP
3293 }
3294 \exstep{By default the Jmol
3295 structure viewer opens in the Jalview desktop. Rotate the molecule by clicking
3296 and dragging in the structure viewing box.
3297 Zoom with the mouse scroll wheel. } 
3298 \exstep{In the Jmol viewer, placing the mouse over a
3299 part of the structure will bring up a tool tip indicating the name and number of that residue.
3300 In the alignment window, the corresponding residue in the sequence is
3301 highlighted in black.}
3302 \exstep{Roll the
3303 mouse cursor along the {\sl FER1\_SPIOL} sequence in the alignment window.
3304 If a residue in the sequence maps to one in the structure, the residue molecular shape is visible in the structure viewer.}
3305 \exstep{Clicking the alpha carbon toggles the highlight and residue label on and
3306 off.
3307 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. }
3308 \exstep{In the structure viewer menu, select {\sl Colours $\Rightarrow$ Background
3309 Colour\ldots} and choose a suitable colour.
3310 Press {\sl OK} to apply this.}
3311 \exstep{Select {\sl File $\Rightarrow$ Save As $\Rightarrow$ PNG} and save the
3312 image. On your computer, view this with a suitable program. } 
3313 \exstep{Select {\sl File $\Rightarrow$ View Mapping} from the structure viewer menu.
3314 A new window opens showing the residue by residue alignment between the sequence and the structure.} 
3315 \exstep{In the structure window,  select {\sl File $\Rightarrow$ Save as $\Rightarrow$ PDB file} and enter a filename to save the PDB file. 
3316 Once the file is saved, open the location in your file browser and drag the PDB file that you just saved onto the Jalview desktop.
3317 (Or load it from the Jalview Desktop menu using
3318 {\sl File $\Rightarrow$ Input Alignment $\Rightarrow$ From File}). 
3319 Verify that you can open and view the associated structure from new alignment window using the sequence ID
3320 context menu's {\sl 3D Structure } submenu (as step {\sl b)}.}
3321
3322 \exstep{In the Jmol window, right click on the background to open the
3323 Jmol menu options. Explore this, for example by
3324 {\sl Select (n) $\Rightarrow$ All} command (where {\sl n} is the number of residues selected), 
3325 and then the {\sl Style $\Rightarrow$ Scheme $\Rightarrow$ Ball and Stick} command.} 
3326 \exstep{In the alignment window, use the {\sl File $\Rightarrow$ Save as.. }
3327 function to save the alignment as a Jalview Project (jvp). Now close the alignment and the structure view, and load the project file you just saved.
3328 Verify that the Jmol display is as it was when you just saved the file.}
3329 {\bf See the video at:
3330 \url{http://www.jalview.org/training/Training-Videos}.}
3331 }
3332
3333 \exercise{Aligning Structures using the Ferredoxin Sequence Alignment}{
3334 \label{superpositionex}
3335
3336 \exstep{Continue with the Jalview project created in exercise
3337 \ref{viewingstructex}}
3338
3339 \exstep{Select the FER1\_MAIZE sequence (near bottom of the alignment). Right-click the ID label to open the context menu, 
3340 select {\sl $\Rightarrow$ 3D Structure Data}.}
3341
3342 \exstep{This opens the Structure Chooser dialog, pick 1gaq from the list.
3343 Make sure the {\sl Superpose} option is checked before clicking the {\bf Add}
3344 button. This superimpose the structure associated with
3345 FER1\_MAIZE with the one associated with FER1\_SPIOL.
3346
3347 {\sl Note:} The Jmol view should update to show both structures, and one will be
3348 moved on to the other. If this doesn't happen, use the Align function in the
3349 Jmol submenu.
3350 }
3351
3352 \exstep{Create a new view on the alignment ({\sl View $\Rightarrow$ New View}), and hide all but columns 121
3353 through to 132 ({\sl View $\Rightarrow$ Hide $\Rightarrow$
3354 All but selected region}).}
3355 \exstep{Select the newly created view in the structure window using {\sl Jmol $\Rightarrow$ Superpose
3356 With } submenu, and then recompute the superposition with {\sl Jmol
3357 $\Rightarrow$ Superpose Structures}.
3358
3359 {\sl Note:} how the molecules shift position when superposed with only a small
3360 region of the alignment.}
3361
3362 \exstep{Compare RMSDs obtained when superimposing molecules with
3363 columns 121-132 and with the whole alignment. The RMSD report can be
3364 viewed by right clicking the mouse on Jmol window, and select {\sl
3365 Console} from the menu (if nothing is shown, recompute the superposition after
3366 displaying the console).}
3367 \exstep{Which view do you think give the best 3D superposition, and why ?} }
3368
3369 \exercise{Setting Chimera as the default 3D Structure Viewer}{
3370 \label{viewingchimera} 
3371 Jalview supports molecular structure
3372 visualization using both Jmol and Chimera 3D viewers. Jmol is the default
3373 viewer, however Chimera can be set up as the default choice from Preferences.
3374
3375 \exstep{First, Chimera must be downloaded and installed on the computer.
3376 Chimera program is available on the UCSF web site \textsf{https://www.cgl.ucsf.edu/chimera/download.html}.}
3377 \exstep{In the desktop menu, select {\sl Tool  $\Rightarrow$ Preferences}. In
3378 the ``{\sl
3379 Structure}'' tab set {\sl Default structure viewer} as {\sl
3380 Chimera}; then click {\sl OK}.} 
3381 \exstep{Close the Jalview program, from the
3382 {\sl Desktop menu} select {\sl Jalview $\Rightarrow$ Quit Jalview}. Then reopen
3383 Jalview, Chimera should open as the default viewer.}
3384 If this does not work then you may need to set the {\sl Path to Chimera program} in {\sl Preferences}.
3385 {\sl Note:} The Jmol structure viewer sits within the Jalview desktop. However
3386 the Chimera structure viewer sits outside the Jalview desktop and