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