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