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