Skip to content

Commit

Permalink
updating about menu and docs, refs #26988
Browse files Browse the repository at this point in the history
  • Loading branch information
maximilianh committed Dec 8, 2021
1 parent 3e259d2 commit 305e23e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/interface.rst
Expand Up @@ -9,6 +9,7 @@ Selecting a dataset and learning about it
When you first open https://cells.ucsc.edu or your local cell browser, you will be greeted by a dataset select screen. This image highlights some of these features, or read more about them below the image.

.. image:: images/cellbrowser-DatasetOverview.converted.jpg
:width: 1000
:alt: Image showing Cell Browser dataset select screen, with organ filter, dataset info pop-up, and dataset open button labeled

The datasets available are listed on the lefthand side of the screen. Datasets can be filtered using organ labels (e.g. skin, kidney) if available. If you select a dataset, information about it will be shown on the right. There are three informational tabs:
Expand All @@ -25,6 +26,7 @@ Basic Cell Browser features
After you have opened a dataset, you will be taken to the main way of visualizing datasets in the Cell Browser, an annotated scatterplot derived from UMAP, tSNE, or some other dimensionality reduction method. The image below highlights some of the main features of this core visualization:

.. image:: images/cellbrowser-BasicUiFeatures.converted.jpg
:width: 1000
:alt: Cell Browser interface with various aspects labeled, including legend, metadata coloring, cluster labels, zoom buttons, cursor modes, and more

The main scatterplot will be colored by default using a field from the "Annotation" tab on the lefthand side of the screen and can be changed by clicking on a new field. The values in the selected field are shown in the "Legend" on the righthand side of the screen. You can zoom in or out on this plot using the buttons in the lower left of the screen or your center mouse wheel with the "100%" button or space bar returning you to the default zoom. Depending on the cursor mode, you can:
Expand All @@ -42,6 +44,7 @@ Color the display by gene expression
In addition to being able to color by metadata as described in the previous section, you can color the scatterplot by gene expression. Start by selecting the "Gene" tab on the lefthand side and searching for a gene symbol in the search box.

.. image:: images/cellbrowser-GeneColoring.converted.jpg
:width: 1000

Expression values are divided up into bins and associated with gradient of colors going from light to dark as shown in the legend on the right.

Expand All @@ -55,6 +58,7 @@ View expression heatmap or split the display
The Cell Browser also provides other methods for exploring datasets: split-screen mode and expression heatmap for the dataset genes.

.. image:: images/cellbrowser-SplitHeat.converted.jpg
:width: 1000

The main Cell Browser view can also be split into two panes for easy comparison of two different metadata fields or gene expression patterns or a combination of the two. Enable split-screen using View > Split screen or typing t. The currently selected panel is boxed in black with the legend reflecting the current panel. If you want to change the coloring for a panel, select it by clicking it, and then changing the coloring to whatever annotation or gene you want.

Expand All @@ -67,6 +71,7 @@ View cluster marker genes
If available, clicking on the cluster labels in the main scatterplot view will bring up a list of marker genes for that cluster.

.. image:: images/cellbrowser-Markers.converted.jpg
:width: 1000

By default, the genes are sorted by p-value, but can be sorted by any of the other columns as well. At minimum, the pop-up will include the gene symbol and a score, but can be augmented with other scores or even links out to other resources like OMIM. If you click on the gene symbol in the first column, it will color the scatterplot by the expression of that gene. If a dataset includes a UCSC Genome Browser hub, small "genome" links will appear next to the gene symbols and clicking those will take you a genome browser view centered on that gene with the hub tracks displayed.

Expand Down
3 changes: 2 additions & 1 deletion src/cbPyLib/cellbrowser/cbWeb/js/cellBrowser.js
Expand Up @@ -2498,7 +2498,8 @@ var cellbrowser = function() {
htmls.push('<a href="#" class="dropdown-toggle" data-toggle="dropdown" data-submenu role="button" aria-haspopup="true" aria-expanded="false">Help</a>');
htmls.push('<ul class="dropdown-menu">');
htmls.push('<li><a href="#" id="tpAboutButton">About</a></li>');
htmls.push('<li><a href="#" id="tpTutorialButton">Tutorial</a></li>');
htmls.push('<li><a href="https://cellbrowser.readthedocs.io/en/master/interface.html" target=_blank id="tpQuickstartButton">How to use this website</a></li>');
htmls.push('<li><a href="#" id="tpTutorialButton">Interactive Tutorial</a></li>');
htmls.push('<li><a target=_blank href="https://github.com/maximilianh/cellBrowser#readme" id="tpGithubButton">Setup your own cell browser</a></li>');
htmls.push('</ul>'); // Help dropdown-menu
htmls.push('</li>'); // Help dropdown container
Expand Down

0 comments on commit 305e23e

Please sign in to comment.