Tips and documentation for the NCBI Sequence Viewer
Background
The NCBI Sequence Viewer
(http://www.ncbi.nlm.nih.gov/projects/sviewer/)
is being phased in to replace the graphical display option
available from the Nucleotide and Protein databases. The functions
included with the first release of this viewer are limited. As new
functions are released, they will be documented here.
Quick start
This section summarizes the basic steps to control the sequence
being viewed, and to navigate through that sequence. Explanations
are based on the default options.
Overview
Click on this link for access to
NCBI Sequence Viewer.
Enter an accession or gi in the Accession box
and press enter.
The default result (Figure 2) now includes two sequence-based panels:
- Overview Panel (top)
- Graphical Panel (below)
Please note that the overview panel contains a tabbed selection window that controls the extent of the display in the lower graphical panel
.
The lower panel reports the coordinates of the sequence being displayed, and diagrams the placement of the features annotated within that range.
Navigation through sequence
Selection window:
The region of the sequence displayed in any view panel below
the Overview Panel is controlled by the tabbed grayed box
(selection window) outlined in a color that matches the
color used to outline the secondary view panel. To expand
or contract the selection window, hover over the small
boxes (with arrowheads)
,
toward the top of the selection window, and move the boxes
when
appears.
To move to a new location, drag the box using the tab at
the top of the selection window.
View panel
No matter what the type of view panel being displayed, you
can alter the sequence display by entering the sequence
coordinates in the Position box
.
A tool tip is attached to the word Position, indicating
that ranges may be defined in two ways:
- begin-end or
- center position:length.
Values should be entered without commas, and k or m can be
used to indicate kbp or Mb, respectively.
You can also move up or downstream by clicking on the arrow
keys.
In a graphical panel (Figure 3), you can alter the display by
moving your cursor to the top or bottom of the display (a
hand will appear) and dragging the window to the left or
right. The selection window in the overview panel will
move coordinately. You can also move the selection window
in the overview panel directly.
If you are in a graphical panel, you can open a different type of display, the Sequence text panel (Figure 4) by clicking on the
icon.
In a sequence text panel (Figure 4), you can move the display
upstream or downstream by using the left or right arrows on
your keyboard, respectively. You may also move the
selection window in the overview panel. The displays in the
graphical and sequence panels are independently
controlled.
Zooming
You can zoom in and out in a view panel in several ways
- Zoom in
- Magnifying glass icon with the plus sign
- Keystrokes: "+" or lower case "z"
- Zoom out
- Magnifying glass icon with the minus sign
- Keystrokes: "−" or upper case "Z"
- Zoom to sequence
- "ATG" icon in the graphical panel
- Keystrokes: "*"
Default displays
Several features are displayed in the overview and graphical
panels. These are distinguished both by position in the panel
and by the color assigned to each. These colors can be altered
by use of the Configure Panel
. This example is
based on a subsequence of AL020997.1
-
Gray − the whole sequence.
-
Green − position of part of the gene
feature, with the locus_tag and orientation displayed
-
Blue − position of some exons (thicker
section) and introns (thinner section) of the RNA, when
translated, that would result in CAI20567.1
-
Red − position of part of a regions
(thicker section) and introns (thinner section
-
Black − any other feature type (variation,
makers, regulatory sites)
-
Blue − a selected RNA feature (click on
the feature to select it) displaying mRNA coordinates of
the sequence
Representative displays
-
Protein sequence: gi|56158846 Note that the default view panel is sequence text.
-
Viral genome: AC_000020, graphical and sequence views and 2 markers
Note that one of the markers (4800) is in the region
of overlap of the two view panels. Note also the color
matching of the marker icons and the color matching of
the control panels for each view panel and its tabbed
selection window in the overview panel.
-
Human chromosome: NC_000001 Note that in the display of a
chromosome, a histogram of gene density is provided in
the overview panel. The default for the view panel is
graphic.
-
Human contig, 4MB: NT_011515, first 30k in graphical view
This is an example of setting a graphical view panel
of 30kb via the URL
-
Human RefSeq for beta globin: NG_000007 Note both the
graphical display of the placement of regulatory
regions (black), a gene (green), an mRNA (blue) and a
coding sequence (red). Details about each feature icon
are provided via mouseover.
- A segmented set: AH000039
- RefSeq mRNA: NM_198471.2
- MGC mRNA: BC066124.1
- Trace ti=555
Detailed description of visual components
Display resulting from the URL constructed as
/projects/sviewer/?id=NG_005895.1&v=5827:1000;f:80,2642..6835;g;s:077d765e-00000e63-0000ad76-010a-a6104eb4&m=6095,3566.
Figure 6 shows six sections of a display:
-
The common NCBI menu panel
with a help button
- The Sequence Title Panel
- The Overview Panel
- A Sequence Text Panel
- A Sequence Graphical Panel
- The NCBI footer
This panel contains:
- Links to a subset of resources of NCBI,
- Name and version of Sequence Viewer
- Help button to display this help document.
The Sequence Title Panel
The Sequence Title Panel includes:
- The title of the sequence.
- The gi of the sequence, its source (GenBank, RefSeq, etc.) and the accession.version.
-
Accession box. Enter the accession or gi of a sequence and press enter to display it.
-
Refresh Button. Clicking on this will refresh all panels.
-
Link Button. Create the URL that will generate the current view.
The Overview Panel
This panel includes several functions to control your display and position within the sequence.
The Overview Panel includes:
-
New Graphical panel. Click on this button to open a new graphical view based on the position of the current view.
-
New Sequence panel (ATGC). Click on this button to open a new sequence view starting
from the position of the current view.
-
Shift Origin box. Enter a value and press "Enter" to shift the origin of all rules.
-
Theme menu. Select your preferred theme for visible elements.
-
The wrench button. Click on this button to open the Configure Panel
to customize your display.
-
The inverted triangle/+ button. Click on this icon to create a new marker (at the left of the display)
and a new window to control the marker's position. Up to 5 markers (distinguished by colors) can be created.
-
Marker coordinate box. Displays the current position of the marker indicated by its
color at the left of the window. You can enter a new value and press enter to move the marker.
-
Delete marker button. Click to delete that marker.
-
Tab to move the graphical/sequence view position. Click and drag to shift
the position without changing the window size
-
Handle to reset the left boundary of the graphical/sequence view. Click and drag to adjust the starting position.
-
Location box. This box represents the width and position of a graphical/sequence view on the complete sequence.
The boundary of the box is color-coded to match the boundary of the view panel it represents.
-
Handle to reset the right boundary of the graphical/sequence view . Click and drag to adjust the end position.
-
Marker icon. Click and drag to move the marker. The new position will be displayed
in the color-matched marker coordinate box.
-
Sequence overview image. This display is controlled by the Theme menu and the Panorama Control Panel.
A Sequence Text Panel
The Sequence Text Panel includes:
-
New Graphical panel. Click on this button to open a new graphical view based on the position of the current view.
-
The inverted triangle/+ button. Click on this icon to create a new marker (at the left of the display)
and a new window to control the marker's position. Up to 5 markers (distinguished by colors) can be created.
-
Position label. Click to switch between methods to enter position, either as a range (19.5k-20.5k)
or center position and length (20K:1000).
-
Position entry box. Enter a position and press enter to change the position of sequence to display.
-
Refresh Button. Click to refresh this panel.
-
Left arrow. Click to move left/upstream the number of nucleotides corresponding to 1/10 of your display window.
-
Right arrow. Click to move right/downstream the number of nucleotides corresponding to 1/10 of your display window.
-
Zoom in. Click to zoom in.
-
Zoom out. Click to zoom out.
-
@@@@. @@@.
-
Collapse the sequence panel..
-
Delete the panel.
-
Coordinates. Range of the sequence being shown on that line.
-
Coordinates. Numbering by 10 for the line shown.
-
@@@. @@@
-
@@@. @@@
-
Position of marker. This box can be dragged to move the marker.
This position of the marker will be updated in the Overview panel.
-
Exon highlights. Different coloration to indicate exon position.
-
Reflector. Bar (color-coded) to indicate how the range of sequence covered in
a graphic panel corresponds to the range displayed in this sequence panel.
A Sequence Graphical Panel
The Panel includes:
-
New Sequence panel (ATGC). Click on this button to open a new sequence view starting from the position of the current view.
-
The inverted triangle/+ button. Click on this icon to create a new marker (at the left of the display) and a new window to control the marker's position. Up to 5 markers (distinguished by colors) can be created.
-
Position label. Click to switch between methods to enter position, either as a range (19.5k-20.5k) or center position and length (20K:1000)
-
Position entry box. Enter a position and press enter to change the position of sequence to display.
-
Refresh Button. Click to refresh this panel.
-
Left arrow. Click to move left/upstream the number of nucleotides corresponding to 1/10 of your display window.
-
Right arrow. Click to move right/downstream the number of nucleotides corresponding to 1/10 of your display window.
-
Sequence text icon. Click to display sequence (100 nucleotides) overlaid on the graphical view.
-
Zoom in. Click to zoom in.
-
Zoom out. Click to zoom out.
-
Theme menu. Select your preferred theme for visible elements.
-
The wrench button. Click on this button to open the Configure Panel
to configure the panel.
-
Collapse the panel.
-
Delete the panel.
-
Scrollable part of the graphical view. Click and drag to move up or downstream.
-
Marker control. Click and drag to move the marker.
-
Coordinate label. This display results from clicking on the mRNA feature.
-
Feature label. This display results from mouse over on the mRNA feature.
-
Reflector. Bar (color-coded) to indicate how the range of sequence covered in a sequence panel corresponds to the range displayed in this graphical panel. In this example, the sequence panel covers 1 kb between 19.5K and 20.5K
The footer includes:
The links to the Contact, Copyright, Disclaimer, Privacy and Accessibility information; NCBI address.
Data of last updating of NCBI Sequence Viewer and its revision number.
Configure Panel
This box opens when you click on the icon shaped like a wrench in the overview or graphical panels. You can drag it to another position so
it will not mask what you want to display,
- The title indicates which panel will be configured (Overview or Viewport)
- Delete button. Click to close this window and ignore any changes.
- Set of configuration elements:
- Color
- default colors are gene for genes, blue for RNAs, red for coding regions, black for any other feature.
- Grey scale: differentiation is provided by grey scale.
- High contrast:
- Decoration. Several options are provided to indicate directionality of features.
Sequence viewer displays all annotations under the sequence, so orientation
is not indicated by position over or under a sequence, but by arrows.
- Content
- Default: Genes, mRNAs, CDS, markers
- Assembly details: component sequences assembled to create the displayed sequence
- Everything: all features annotated on the sequence
- Genes: Genes, mRNAs, CDS
- Genes, Markers; Genes, mRNAs, CDS, markers
- Genes, SNPS: Genes, mRNAs, CDS, SNPs
- Layout
- Default: annotation on the displayed sequence only
- Level 1: same as default
- Level 2: annotation on components of the displayed sequence
- Level 3: annotation on components of components of the displayed sequence
- Multilevel: annotation from all levels
- Spacing
- Default
- Oversize: bars are twice as thick as the default
- Overview: bars are half the thickness of the default
- Close button. Click to close this window and ignore any changes.
- Apply button. Apply changes you made. The window remains open.
Access by URL
The base URL is http://www.ncbi.nlm.nih.gov/projects/sviewer/?<List-of-arguments>
Arguments and argument qualifiers:
-
id
- Required to identify the sequence
- Processes nucleotide gis, protein gis, accessions, accession.versions
?id=NG_005895
-
v
- Optional; opens a new viewport for a bounded range (start-stop) or
opens a new viewport of a given size centered at a position (centerpoint:length)
- Range as a start-stop
?id=NG_005895&v=1K-3K
- Centered position as centerpoint:length;
default additional view (viewport) is graphical if ;f is added, the viewport will be text
?id=NG_005895&v=4.5k:1k
- Content qualifier, options 0,1,2,3,4,5, corresponding to the content choices in
the Configure Panel
, where 0=default; 1=Assembly details; 2=Everything; 3=Genes; 4=Genes,Markers;
and 5=Genes, SNPs. Thus, to open a graphical panel showing gene and variation (SNP) features:
?id=NG_005895&v=5.5K-7K;g;content:5
- Layout qualifier, options 0,1,2,3,4, corresponding to the layout choices in
the Configure Panel
, where 0=default; 1=Level 1; 2=Level 2; 3=Level 3; 4=Multilevel;
- Spacing qualifier, options 0,1,2,3, corresponding to the spacing choices in
the Configure Panel
, where 0=default; 1=Oversize; 2=Overview
Thus, to open a graphical panel showing gene and variation (SNP) features, with overview spacing
?id=NG_005895&v=5.5K-7K;g;content:5;spacing:2
-
m
- Optional: sets a marker at a defined position, in one or more viewports
Options for reporting positions include full integers (without
commas), or float with k for 1000, m for 100000. Use of k or m is
NOT case-sensitive.
Compatible browsers
- MS Windows
- Microsoft Internet Explorer 7
- Firefox 2
- Opera 9.5
- Mac OS X
- Firefox 2
- Safari 3
- Linux
- Firefox 2
Sequence Viewer Development Team
The Sequence Viewer was created entirely at NCBI using the NCBI C++
Toolkit and JavaScript components. The code base for the Sequence
Viewer is shared with Genome Workbench, and the development team will be working on
providing complete integration of Genome Workbench components for
the web.
The Sequence Viewer development team includes:
- Michael DiCuccio, Technical Lead
- Vlad Lebedev
- Sergey Ponomarev
- Vladimir Tereshkov
- Yury Voronov
- Andrey Yazhuk