From: Jim Procter
Date: Thu, 10 Sep 2015 01:53:26 +0000 (+0100)
Subject: JAL-1645 yet more documentation tweaks
X-Git-Tag: Release_2_10_0~443
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=de255c8c87707a2cd2a2a15f5ad04ed10fe5846d;p=jalview.git
JAL-1645 yet more documentation tweaks
---
diff --git a/help/html/features/annotationsFormat.html b/help/html/features/annotationsFormat.html
index 60c9e23..4c8ad39 100755
--- a/help/html/features/annotationsFormat.html
+++ b/help/html/features/annotationsFormat.html
@@ -211,38 +211,43 @@ Group association is turned off for subsequent annotation rows by:
GROUP_REF ALIGNMENT
-VIEW_SETREF, VIEW_HIDECOL and HIDE_INSERTIONS
-Since Jalview 2.9, the Annotations file has also supported the definition of reference sequences and hidden regions for an alignment view.
-
-
- VIEW_SETREF marks the first sequence in the alignment, or
- alternately, the one specified by the most recent SEQUENCE_REF
- statement, as the reference
- sequence for the alignment.
-
-
- HIDE_INSERTIONSThis command hides all gapped positions in the
- current target sequence. Any columns already hidden will be
- re-displayed.
-
The current target sequence is either the one specified by
- the most recent SEQUENCE_REF statement, the alignment's
- reference sequence, or the first sequence in the alignment.
-
-
- VIEW_HIDECOLS modifies the visibility of columns in the view.
- The statement is followed by a single argument consisting of a comma
- separated series of single integers or integer pairs (like 3-4).
- These define columns (starting from the left-hand column 0) that
- should be marked as hidden in the alignment view.
-
+
+ VIEW_SETREF
Marks the first sequence in the alignment,
+ or alternately, the one specified by the most recent SEQUENCE_REF
+ statement, as the reference
+ sequence for the alignment.
+
+
+ HIDE_INSERTIONS
This command hides all gapped
+ positions in the current target sequence. Any columns already hidden
+ will be re-displayed.
The current target sequence is
+ either the one specified by the most recent SEQUENCE_REF
+ statement, the alignment's reference sequence, or the first sequence
+ in the alignment.
+
+
+ VIEW_HIDECOLS
Modifies the visibility of columns in
+ the view. The statement is followed by a single argument consisting
+ of a comma separated series of single integers or integer pairs
+ (like 3-4). These define columns (starting from the
+ left-hand column 0) that should be marked as hidden in the alignment
+ view.
+
-
-COMPATIBILITY NOTES
+
+ COMPATIBILITY NOTES
The interpretation of the COMBINE statement in Version 2.8.1 was refined
so that only annotation line graphs with the given names ands the same
SEQUENCE_REF and GROUP_REF scope are grouped.
diff --git a/help/html/features/viewingpdbs.html b/help/html/features/viewingpdbs.html
index 3586083..6419525 100755
--- a/help/html/features/viewingpdbs.html
+++ b/help/html/features/viewingpdbs.html
@@ -28,23 +28,31 @@
Jalview can be used to view protein structures by following the steps below:
- - Select the "View Structure" option from a
- sequence's pop-up menu to invoke the Structure Chooser interface.
+
- Select the "3D Structure Data..." option from a
+ sequence's pop-up menu to open the Structure Chooser dialog box.
- If one or more structures exists for the given sequence, the Structure Chooser
- dialogue is opened with a list of the found structures meta-data.
- - However, if no structure was found, the Structure Chooser interface is opened with options for manual association of PDB structures.
+ dialog will open with them listed in the results pane.
+ - However, if no structure was found, the Structure Chooser interface will present options for manual association of PDB structures.
- - Choose the structure to view from the discovered list. This can be done either manually by clicking directly
- on the desired structure(s) in the list, or automatically by
- using the drop-down menu on the interface to filter and auto-select the best structure based on certain
- criteria like quality, resolution, etc.
- - When the desired structure(s) have been selected, they can be
- viewed by clicking the "View" button below the summary list.
-
-
-
+ Selecting Structures
If structures
+ have been discovered, then some will already be selected according
+ to predefined selection criteria, such as structures with the
+ highest resolution. Use the drop down menu to select structures
+ according to different criteria, or, alternatively, choose
+ structures manually by selecting with the keyboard and mouse.
+
+ - Viewing Cached Structures
If you
+ have previously downloaded structures for your sequences, they
+ can be viewed by selecting the Cached PDB
+ Entries option from the drop down menu at the top of the
+ dialog box.
+
+ To view selected structures, click the "View"
+ button.
+
+
The
Jmol viewer has been included since Jalview
@@ -59,29 +67,8 @@
href="xsspannotation.html">Annotation from Structure page for
more information.
-
-If a single pdb
+
If a single PDB
structure is selected, one of the following will happen:
@@ -109,7 +96,7 @@ this service are automatically associated with their source database
entry. For PDB sequences, simply select PDB as the database and enter
your known PDB id (appended with ':' and a chain code, if desired).
Jalview will also read PDB files directly. Simply load in the file as
-you would an alignment file. The sequences of any peptide chains will be
+you would an alignment file. The sequences of any protein or nucleotide chains will be
extracted from the file and viewed in the alignment window.
diff --git a/help/html/menus/alignmentMenu.html b/help/html/menus/alignmentMenu.html
index 5bf9e60..7102fd7 100755
--- a/help/html/menus/alignmentMenu.html
+++ b/help/html/menus/alignmentMenu.html
@@ -24,10 +24,11 @@
-
- Alignment Window Menus
-
-
- Select
- - Find...
- (Control F)
Opens the Find dialog box to
- search for residues, sequence name or residue position within the
- alignment and create new sequence features from the queries.
-
- - Select All (Control A)
Selects
- all the sequences and residues in the alignment.
Use
- <CTRL> and A (<APPLE> and A on a MacOSX) to select
- all.
- - Deselect All (Escape)
Removes
- the current selection box (red dashed box) from the alignment
- window. All selected sequences, residues and marked columns will
- be deselected.
Use <ESCAPE> to deselect
- all.
- - Invert Sequence Selection (Control I)
- Any sequence ids currently not selected will replace the
- current selection.
-
- - Invert Column Selection (Control Alt I)
- Any columns currently not selected will replace the current
- column selection.
-
- - Create Group (Control G)
- Create a group containing the currently selected sequences.
+ - Find... (Control F)
+ Opens the Find dialog box to search for residues, sequence name or residue
+ position within the alignment and create new sequence features from the queries.
+
+ - Select All (Control A)
+ Selects all the sequences and residues in the alignment.
+ Use <CTRL> and A (<APPLE> and A on a MacOSX) to select all.
+ - Deselect All (Escape)
+ Removes the current selection box (red dashed box) from the
+ alignment window. All selected sequences, residues and marked columns
+ will be deselected.
+ Use <ESCAPE> to deselect all.
+ - Invert Sequence Selection (Control I)
+ Any sequence ids currently not selected will replace the
+ current selection.
+ - Invert Column Selection (Control Alt I)
+ Any columns currently not selected will replace the current
+ column selection.
+ - Create Group (Control G)
+ Create a group containing the currently selected sequences.
- Remove Group (Shift Control G)
- Ungroup the currently selected sequence group. (Create/Remove group new in Jalview 2.8.1)
- - Make Groups for selection
The currently
- selected groups of the alignment will be subdivided according to
- the contents of the currently selected region.
Use this to
- subdivide an alignment based on the different combinations of
- residues observed at specific positions. (new in Jalview 2.5)
-
- - Undefine Groups (Control U)
The
- alignment will be reset with no defined groups.
WARNING:
- This cannot be undone.
-
+ Ungroup the currently selected sequence group.
+ - Make Groups for selection
The
+ currently selected groups of the alignment will be subdivided
+ according to the contents of the currently selected region.
Use
+ this to subdivide an alignment based on the different combinations
+ of residues at marked columns.
+
+ - Undefine Groups (Control U)
+ The alignment will be reset with no defined groups.
+ WARNING: This cannot be undone.
+ - Select/Hide Columns by Annotation
+ Select or Hide columns in the alignment according to
+ secondary structure, labels and values shown in alignment
+ annotation rows.
View
- Calculate Tree
Functions
- for calculating trees on the alignment or the currently selected
- region. See calculating
- trees.
-
- - Average Distance Using % Identity
- - Neighbour Joining Using % Identity
- - Average Distance Using Blosum62
- - Neighbour Joining Using Blosum62
-
-
- Note: Since Version 2.8.1, a number of additional similarity measures for tree calculation are provided in this menu.
-
+ Calculate Tree
Functions
+ for calculating trees on the alignment or the currently
+ selected region. See calculating
+ trees.
+
+
+ - Neighbour Joining Using PAM250
+ - Neighbour Joining Using Sequence
+ Feature Similarity
+ - Neighbour Joining Using Blosum62
+ - Neighbour Joining Using % Identity
+ - Average Distance Using PAM250
+ - Average Distance Using Sequence
+ Feature Similarity
+ - Average Distance Using Blosum62
+ - Average Distance Using % Identity
+
Note: Since Version 2.8.1, a number of
+ additional similarity measures for tree calculation are
+ provided in this menu.
Pairwise Alignments
Applies
Smith and Waterman algorithm to selected sequences. See pairwise alignments.
diff --git a/help/html/menus/alwannotationpanel.html b/help/html/menus/alwannotationpanel.html
index b760270..d3a58c5 100755
--- a/help/html/menus/alwannotationpanel.html
+++ b/help/html/menus/alwannotationpanel.html
@@ -29,7 +29,7 @@
This menu is opened by clicking anywhere on the annotation row labels
area (below the sequence ID area).
- - Add New Row
+ - Add New Row
Adds a new, named annotation row (a dialog box will pop up for you
to enter the label for the new row).
- Edit Label/Description
diff --git a/help/html/menus/alwcalculate.html b/help/html/menus/alwcalculate.html
index 10b5611..a1c630e 100755
--- a/help/html/menus/alwcalculate.html
+++ b/help/html/menus/alwcalculate.html
@@ -30,20 +30,20 @@
- Sort
- - by ID
This will sort the
+ - By ID
This will sort the
sequences according to sequence name. If the sort is repeated, the
order of the sorted sequences will be inverted.
- - by Length
This will sort
+ - By Length
This will sort
the sequences according to their length (excluding gap
characters). If the sort is repeated, the order of the sorted
sequences will be inverted.
- - by Group
This
+ - By Group
This
will sort the sequences according to sequence name. If the sort is
repeated, the order of the sorted sequences will be inverted.
- - by Pairwise Identity
This
+ - By Pairwise Identity
This
will sort the selected sequences by their percentage identity to
the consensus sequence. The most similar sequence is put at the
top.
@@ -53,28 +53,32 @@
associated score annotation, or you have just done a multiple
alignment calculation or opened a tree viewer window.
- - Calculate Tree
Functions
- for calculating trees on the alignment or the currently selected
- region. See calculating
- trees.
-
- - Average Distance Using % Identity
-
- - Neighbour Joining Using % Identity
-
- - Average Distance Using Blosum62
-
- - Neighbour Joining Using Blosum62
-
-
-
- - Pairwise Alignments
Applies
+ - Calculate Tree
Functions
+ for calculating trees on the alignment or the currently selected
+ region. See calculating
+ trees.
+
+
+ - Neighbour Joining Using PAM250
+
+ - Neighbour Joining Using Sequence
+ Feature Similarity
+ - Neighbour Joining Using Blosum62
+
+ - Neighbour Joining Using % Identity
+ - Average Distance Using PAM250
+
+ - Average Distance Using Sequence
+ Feature Similarity
+ - Average Distance Using Blosum62
+ - Average Distance Using % Identity
+
+ - Pairwise Alignments
Applies
Smith and Waterman algorithm to selected sequences. See pairwise alignments.
- Principal Component Analysis
Shows
- a spatial clustering of the sequences based on the BLOSUM62 scores
- in the alignment. See Principal
+ a spatial clustering of the sequences based on similarity scores calculated over the alignment.. See Principal
Component Analysis.
- Extract Scores ... (optional)
This
option is only visible if Jalview detects one or more white-space
@@ -99,6 +103,12 @@
this option is selected, the alignment will be automatically sorted
whenever a new tree is calculated or loaded.
-
+ - Show Flanking Regions
Opens
+ a new alignment window showing any additional sequence data
+ either side of the current alignment. Useful in conjunction with
+ 'Fetch Database References' when the 'Trim Retrieved Sequences'
+ option is disabled to retrieve full length sequences for a set
+ of aligned peptides.
+