Viewing Input Data to PCA and Tree calculations

From: jprocter Date: Tue, 22 Aug 2006 13:13:23 +0000 (+0000) Subject: documentation X-Git-Tag: Release_2_1~5 X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=e3f4349374e532d0f9bb2bc163ff1783ca030fd6;p=jalview.git documentation --- diff --git a/help/help.jhm b/help/help.jhm index 8c314d3..41d245d 100755 --- a/help/help.jhm +++ b/help/help.jhm @@ -10,6 +10,7 @@ + @@ -35,7 +36,7 @@ - + diff --git a/help/helpTOC.xml b/help/helpTOC.xml index d08e3d2..5dec601 100755 --- a/help/helpTOC.xml +++ b/help/helpTOC.xml @@ -3,9 +3,11 @@ - - + + + + @@ -22,10 +24,12 @@ + - + + diff --git a/help/html/calculations/recoverInputdata.html b/help/html/calculations/recoverInputdata.html new file mode 100644 index 0000000..b582952 --- /dev/null +++ b/help/html/calculations/recoverInputdata.html @@ -0,0 +1,13 @@ + +Viewing Input Data to PCA and Tree calculations + + +

Viewing Input Data to PCA and Tree calculations

It is always possible to retrieve the input data used to calculate + a tree or PCA plot by using the analysis window's + "File + -> Input Data..." menu item. The Input Data will be + shown in a new alignment window, with any hidden columns + preserved.

+ + diff --git a/help/html/features/dassettings.html b/help/html/features/dassettings.html index 4e89532..f3e325d 100644 --- a/help/html/features/dassettings.html +++ b/help/html/features/dassettings.html @@ -4,19 +4,25 @@

DAS Settings

Jalview can retrieve features from multiple DAS - sources. The DAS sources are selected in the DAS settings panel.

Jalview can retrieve and visualize features from many DAS + sources at once. The DAS sources are discovered and selected via the DAS settings panel.

On start up of the DAS Settings panel, Jalview will use the registry URL (default - is http://das.sanger.ac.uk/registry/das1/sources/) to retrieve a list of currently - available DAS sources. These are all listed in the table using the sources' - Nickname as an identifier.
- Click on a Nickname in the table to reveal more information about that service - in the panel to the right of the table. +

The available sources are listed in the table using each source's +Nickname as its identifier. Clicking on a source's entry in the table +reveals more information about that service in the panel to the +right. Select the tickbox in the "Use Source" column for a +source to add it to the set Jalview queries for alignment and sequence +features. +

You can filter the visible DAS sources by authority, type and "label". You should read the DAS documentation to understand more about these values. -

Tick the box "Use Source" so that Jalview will use a particular source - when fetching features. +

Updating the list of sources

When the DAS Settings panel is first opened, and when the 'Refresh + source' buton is pressed, a list of DAS sources + is retrieved from the DAS registry URL (set by default to the DAS + registration server at + http://das.sanger.ac.uk/registry/das1/sources/).

Adding your own DAS Sources

You can add your own DAS source to the list by clicking the "Add Local Source" button. Enter the URL and nickname of your additional service. It should be noted that Jalview 2.1 will not query additional sources for more diff --git a/help/html/features/hiddenRegions.html b/help/html/features/hiddenRegions.html index 929481b..172ce80 100644 --- a/help/html/features/hiddenRegions.html +++ b/help/html/features/hiddenRegions.html @@ -5,34 +5,44 @@

Use the keyboard key "H" to hide / reveal selected columns and sequences. To hide / reveal only selected sequences, use "Shift H", to hide / reveal only selected columns, use "Control H".

To hide selected sequences from an alignment, use the "View - -> Hide -> Selected Sequences" menu item or simply select "Hide - Sequences" from the Popup menu after a right click on the sequence Ids. +

Hiding Sequences
+To hide selected sequences in an alignment, use the "View + -> Hide -> Selected Sequences" menu item or simply select "Hide + Sequences" from the Popup menu after a right click on the sequence Ids.

Hidden sequences will not be used in any calculations, editing or web service alignments performed on visible sequences.

A more advanced hide involves a right-mouse click on a sequence, then selecting - "SequenceID -> Represent Group with SequenceId". Using this method +

Hidden Sequences Representatives
+A more advanced hide involves a right-mouse click on a sequence, then selecting + "SequenceID -> Represent Group with SequenceId". Using this method of hiding sequences, any edits performed on the visible group representative will be propogated to all the sequences in that group.
- The hidden sequences will not be used in any calculations or web service alignments. + The hidden representative sequences will not be used in any + calculations or web service alignments (nb. this may change in + the future)

To hide selected columns from an alignment, use the "View - -> Hide -> Selected Columns" menu item, or right click within a region +

Hiding Columns
+To hide selected columns in an alignment, use the "View + -> Hide -> Selected Columns" menu item, or right click within a region of selected columns in the scale above the alignment (only available in non - wrapped mode) and select "Hide Columns".

Hidden columns will not be used in any calculations. This allows you to eg. - create trees from the visible alignment and ignore any poorly aligned sections - of the alignment, without cutting and deleting them permanently from your alignment.
- It is possible to retrieve the input data to any trees, PCA analysis windows - which were created from alignments containing hidden columns by using the "File - -> Input Data..." menu item from the tree window.

Editing the alignment is bound by the hidden columns, ie you cannot move residues - across a hidden column boundary.

Any web service alignments performed on sequences which contain hidden columns - send the alignment as a series of chunks delimited by the hidden columns.

+ wrapped mode) and select "Hide Columns".

When an alignment view contains hidden columns, certain constraints +apply:

Editing the alignment is bound by the hidden columns, i.e. you cannot move residues + across a hidden column boundary.
Tree, pairwise alignment and PCA calculations will only be +performed using the visible parts of the alignment. +
Multiple Sequence + Alignments are performed locally on on each visible chunk of + the input, and concatenated with the hidden regions to form the + final result.
+

The analysis and web service calculations where hidden columns are + excluded are termed column-separable. Calculations which + are not column-separable will be performed on the whole alignmnent + or sequence set, not just the visible regions.

diff --git a/help/html/webServices/index.html b/help/html/webServices/index.html index 22cb247..6b5c5e1 100755 --- a/help/html/webServices/index.html +++ b/help/html/webServices/index.html @@ -21,17 +21,33 @@ possible for some services.

Current services: -

ClustalW Multiple Alignment
- The clustal W service remains one of the more popular Jalview features. +
- Secondary Structure Prediction +
  - JNet
    This is a front end to the existing JNet + www server allowing single sequence or profile + based prediction. +
diff --git a/help/html/webServices/jnet.html b/help/html/webServices/jnet.html index a94ec44..7a6015a 100755 --- a/help/html/webServices/jnet.html +++ b/help/html/webServices/jnet.html @@ -36,6 +36,12 @@ then the alignment will be used for a Jnet prediction on the nearest the top of the alignment window).

Note: JNet secondary structure prediction is a + 'non-column-separable' service - predictions are based on the + sequence profile of contiguous stretches of amino-acid sequence. This + means that all columns of the alignment, or selection will be submitted + for prediction, not just the visible ones (see hiding columns).

The result of a JNet prediction for a sequence is a new annotated alignment window:

diff --git a/help/html/webServices/mafft.html b/help/html/webServices/mafft.html index 34ee58b..4ee0237 100644 --- a/help/html/webServices/mafft.html +++ b/help/html/webServices/mafft.html @@ -1,13 +1,18 @@ -MAFFT Alignment +MAFFT Multiple Sequence Alignments -

MAFFT Alignments

MAFFT is a program for the alignment of many protein sequences.

MAFFT Multiple Sequence Alignments

Katoh, K., K. Kuma, K., Toh, H., and Miyata, T. (2005) "MAFFT version 5: improvement in accuracy of multiple sequence alignment." Nucleic Acids Research, 33 511-518

This alignment method is applied to the selected region, if any, or the whole - sequence set when the Web Service→Alignment→MAFFT Multiple - Sequence Alignment menu item is selected.

MAFFT is a program for the multiple alignment of nucleic acid or protein +sequences, and is available from the Web +Service→Alignment→MAFFT Multiple Sequence +Alignment entry in the web services menu.

MAFFT utilizes algorithms for spectral correlation to identify +homologous regions in a fast-fourier transform representation of each +sequence. The Jalview web service runs MAFFT using the +'--auto' option which picks optimal parameters +for the set of sequences to be aligned.

diff --git a/help/html/webServices/msaclient.html b/help/html/webServices/msaclient.html new file mode 100644 index 0000000..6fea43e --- /dev/null +++ b/help/html/webServices/msaclient.html @@ -0,0 +1,38 @@ + + +Multiple Sequence Alignment Web Service + + +Multiple Sequence Alignment Web Services +

+Multiple sequence alignment services are accessed from the Web +Service→Alignment menu. When an entry from this menu is +selected, either the currently selected residues, or the whole +sequence set (if there is no selection or only one sequence is +selected) will be submitted for multiple sequence alignment. +

There are two kinds of multiple sequence alignment operations +available:

alignment - where a new alignment is constructed from the input +
realignment - +where any existing alignments in the input are passed to the service +for profile based alignment. +

+Multiple Alignments of Sequences with hidden columns
+Multiple alignment services are 'column separable' analysis +operations. If the input contains hidden columns then each +visible segment of the input sequence set will be submitted for +alignment separately, and the results concatenated (with the hidden +regions preserved) once all alignment functions have completed. Each +sub-job's state is reported in its own tab: +

Multiple Multiple Sequence Alignment sub jobs running at +once

+ + diff --git a/help/html/webServices/multimafftjbs.gif b/help/html/webServices/multimafftjbs.gif new file mode 100644 index 0000000..004ba1a Binary files /dev/null and b/help/html/webServices/multimafftjbs.gif differ