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