Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resource listing UI docs #196

Merged
merged 1 commit into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions src/guides/snapshots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,44 @@ the latest available snapshot on July 1st, which was a dataset updated on June
In general, appending a ``@YYYY-MM-DD`` string to a Nextstrain core dataset URL
will load the dataset that was the latest available at that particular date.


.. note::

This functionality is newly introduced in early 2024 and is currently only
available for core Nextstrain datasets. There is not yet a way to see a list /
visualise all the available datasets, but this is in the works.
This functionality is currently only available for core Nextstrain datasets.

Viewing all available (core) resources and their snapshots
==========================================================

`nextstrain.org/pathogens <https://nextstrain.org/pathogens>`__ lists all
available core datasets grouped by pathogen, as well as exposing all the known
snapshots for each resource. Next to each resource you'll see the total number
of available snapshots as well as an indication of how frequently the dataset is
updated, for instance at the time of writing `nextstrain.org/rsv/A/G <https://nextstrain.org/rsv/A/G>`__
had 82 snapshots and was being updated weekly:

.. image:: ../images/snapshots-listing-ui-hover.jpg
:alt: Resource listing UI indicating previous snapshots

Clicking on the dataset name, e.g. ``rsv|a|G`` in the above image, will always
load the latest available dataset.

To view the available snapshots, click on the update frequency/number text to
bring up a view similar to the top-half of the following screenshot:

.. image:: ../images/snapshots-listing-ui-modal.png
:alt: Resource listing UI showing previous snapshots

Here each coloured circle represents an available snapshot, and we can hover
over each to view the date it was uploaded and click to view the dataset itself.
Perhaps a simpler way to explore the data is to move your mouse over the grey
bar, as shown in the lower panel of the screenshot. This will indicate which
dataset was the latest available at the date you're currently hovering over, and
you can click at any time to load that dataset.



Additional information
======================

Tanglegrams to compare changes
------------------------------
Expand Down
Binary file added src/images/snapshots-listing-ui-hover.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/snapshots-listing-ui-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading