From: jprocter Date: Fri, 24 Nov 2006 10:09:41 +0000 (+0000) Subject: new and corrected docs for 2.2 release X-Git-Tag: Release_2_2~37 X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=85fb1c79fd82d7eada801624f745635632be8362;p=jalview.git new and corrected docs for 2.2 release --- diff --git a/help/help.jhm b/help/help.jhm index 41d245d..2e10dbf 100755 --- a/help/help.jhm +++ b/help/help.jhm @@ -1,87 +1,89 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/help/helpTOC.xml b/help/helpTOC.xml index 5dec601..c91faff 100755 --- a/help/helpTOC.xml +++ b/help/helpTOC.xml @@ -1,86 +1,88 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/help/html/calculations/consensus.html b/help/html/calculations/consensus.html index ce11687..71a1719 100644 --- a/help/html/calculations/consensus.html +++ b/help/html/calculations/consensus.html @@ -1,13 +1,18 @@ - -Alignment Consensus Annotation - -

Alignment Consensus Annotation

-

The consensus displayed below the alignment is the percentage of the modal - residue per column. By default this calculation takes includes gaps in column. - You can choose to ignore gaps in the calculation by right clicking on the label - "Consensus" to the left of the consensus bar chart. -

If the modal value is shared by more than 1 residue, a "+" symbol - is used in the display for the simple reason that it is not possible to display - multiple characters in a single character space. - - + +Alignment Consensus Annotation + +

Alignment Consensus Annotation

+

The consensus displayed below the alignment is the percentage of the modal + residue per column. By default this calculation takes includes gaps in column. + You can choose to ignore gaps in the calculation by right clicking on the label + "Consensus" to the left of the consensus bar chart. +

If the modal value is shared by more than 1 residue, a "+" symbol + is used in the display for the simple reason that it is not possible to display + multiple characters in a single character space. +

Copying the consensus sequence

+

Select the "Copy Consensus Sequence" entry from +the consensus annotation label to copy the alignment's consensus sequence to the +clipboard. +

+ + diff --git a/help/html/calculations/pca.html b/help/html/calculations/pca.html index 32ab81d..af6550e 100755 --- a/help/html/calculations/pca.html +++ b/help/html/calculations/pca.html @@ -1,64 +1,64 @@ - -Principal Component Analysis - -

Principal Component Analysis

-

This calculation creates a spatial representation of the -similarities within a selected group, or all of the sequences in -an alignment. After the calculation finishes, a 3D viewer displays the -set of sequences as points in 'similarity space', and similar -sequences tend to lie near each other in the space.

-

Note: The calculation is computationally expensive, and may fail for very large sets of sequences - - usually because the JVM has run out of memory. The next release of - Jalview release will execute this calculation through a web service.

-

Principal components analysis is a technique for examining the -structure of complex data sets. The components are a set of dimensions -formed from the measured values in the data set, and the principle -component is the one with the greatest magnitude, or length. The -sets of measurements that differ the most should lie at either end of -this principle axis, and the other axes correspond to less extreme -patterns of variation in the data set. -

- -

In this case, the components are generated by an eigenvector -decomposition of the matrix formed from the sum of BLOSUM scores at -each aligned position between each pair of sequences. The basic method -is described in the paper by G. Casari, C. Sander and -A. Valencia. Structural Biology volume 2, no. 2, February 1995 (pubmed) - and implemented at the SeqSpace server at the EBI. -

- -

The PCA Viewer

-

This is an interactive display of the sequences positioned within - the similarity space. The colour of each sequence point is the same - as the sequence group colours, white if no colour has been - defined for the sequence, and green if the sequence is part of a - the currently selected group. -

-

The 3d view can be rotated by dragging the mouse with the - left mouse button pressed. The view can also be - zoomed in and out with the up and down arrow - keys. Labels will be shown for each sequence - if the entry in the View menu is checked, and the plot background - colour changed from the View→Background Colour.. dialog - box. The File menu allows the view to be saved (File→Save - submenu) as an EPS or PNG image or printed, and the original - alignment data and matrix resulting from its PCA analysis to be - retrieved. -

-

-

A tool tip gives the sequence ID corresponding to a point in the - space, and clicking a point toggles the selection of the - corresponding sequence in the alignment window. Rectangular region - based selection is also possible, by holding the 'S' key whilst - left-clicking and dragging the mouse over the display. -

-

Initially, the display shows the first three components of the - similarity space, but any eigenvector can be used by changing the selected - dimension for the x, y, or z axis through each ones menu located - below the 3d display. -

-

- - - + +Principal Component Analysis + +

Principal Component Analysis

+

This calculation creates a spatial representation of the +similarities within a selected group, or all of the sequences in +an alignment. After the calculation finishes, a 3D viewer displays the +set of sequences as points in 'similarity space', and similar +sequences tend to lie near each other in the space.

+

Note: The calculation is computationally expensive, and may fail for very large sets of sequences - + usually because the JVM has run out of memory. A future release of + Jalview will be able to avoid this by executing the calculation via a web service.

+

Principal components analysis is a technique for examining the +structure of complex data sets. The components are a set of dimensions +formed from the measured values in the data set, and the principle +component is the one with the greatest magnitude, or length. The +sets of measurements that differ the most should lie at either end of +this principle axis, and the other axes correspond to less extreme +patterns of variation in the data set. +

+ +

In this case, the components are generated by an eigenvector +decomposition of the matrix formed from the sum of BLOSUM scores at +each aligned position between each pair of sequences. The basic method +is described in the paper by G. Casari, C. Sander and +A. Valencia. Structural Biology volume 2, no. 2, February 1995 (pubmed) + and implemented at the SeqSpace server at the EBI. +

+ +

The PCA Viewer

+

This is an interactive display of the sequences positioned within + the similarity space. The colour of each sequence point is the same + as the sequence group colours, white if no colour has been + defined for the sequence, and green if the sequence is part of a + the currently selected group. +

+

The 3d view can be rotated by dragging the mouse with the + left mouse button pressed. The view can also be + zoomed in and out with the up and down arrow + keys (and the roll bar of the mouse if present). Labels + will be shown for each sequence if the entry in the View menu is + checked, and the plot background colour changed from the + View→Background Colour.. dialog box. The File menu allows the + view to be saved (File→Save submenu) as an EPS or PNG image or + printed, and the original alignment data and matrix resulting from + its PCA analysis to be retrieved. +

+

+

A tool tip gives the sequence ID corresponding to a point in the + space, and clicking a point toggles the selection of the + corresponding sequence in the alignment window. Rectangular region + based selection is also possible, by holding the 'S' key whilst + left-clicking and dragging the mouse over the display. +

+

Initially, the display shows the first three components of the + similarity space, but any eigenvector can be used by changing the selected + dimension for the x, y, or z axis through each ones menu located + below the 3d display. +

+

+ + + diff --git a/help/html/calculations/treeviewer.html b/help/html/calculations/treeviewer.html index bc46771..f05572c 100755 --- a/help/html/calculations/treeviewer.html +++ b/help/html/calculations/treeviewer.html @@ -16,9 +16,15 @@ are also reflected in any other analysis windows associated with the alignment, such as another tree viewer.

-

- Clicking on an internal node of the tree will rearrange the tree - diagram, inverting the ordering of the branches at that node. +

Moving the mouse over an internal node of the tree will highlight + it. You can then :

Clicking anywhere along the extent of the tree (but not on a leaf or @@ -47,12 +53,12 @@ retrieved with the 'Input Data...' entry. associated with a tree. Trees calculated by Jalview have branch lengths, which correspond to the distance measure used to construct the tree. Tree imported from outside may also contain bootstrap information, -or additional leaves from sequences not present in the associated +and additional leaves from sequences not present in the associated alignment.

The view menu contains options controlling the way a tree is -rendered and labelled:

-