Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 3.85 KB

README.md

File metadata and controls

62 lines (38 loc) · 3.85 KB
Raw

Deployed version : https://metacell.github.io/sds-viewer/

SDS Viewer User Manual

The SDS Viewer can now be launched directly from datasets and models on the SPARC Portal (https://sparc.science/). From the landing page for your dataset or model of interest, simply click the SDS Viewer button, it will launch the viewer with it already loaded. In addition, users can load SPARC datasets using two other methods:

  1. Loading a SPARC Dataset from app:

    • Click on 'SPARC Datasets' button, it's located on the lower left corner.
    • On the window that opens up, select the dataset you want to load. You can search by dataset title and id. image
    • After selection, click 'Done'
    • Dataset will be loaded.

  2. Loading a dataset specifying DOI as parameter:

    • Users can specify the DOI of a SPARC Portal dataset as a parameter on the URL and load it this way.
    • For example, if user wants to load Dataset with DOI 10.26275/qskp-awpu, we can add the id as parameter : https://metacell.github.io/sds-viewer/?doi=10.26275/qskp-awpu This will open up the SDS Viewer with the dataset already loaded.
Loaded dataset example

image

SPARC Dataset used

image

Navigating the SDS Viewer

  • Users can search for subjects, folders and files on the sidebar. Selecting an item on the sidebar will display the Metadata for it and zoom the Graph to its corresponding folder or file. image

  • Selecting an item on the Graph will display its Metadata. Users can view Metadata for the Dataset's Subjects and Samples, along with its folders and files contents. Users can find links to the SPARC Portal for Subjects, Samples, Folders and Files.

image

  • Navigating the Graph Viewer can be done with the mouse. There are also controllers on the bottom right that allow user to change the Graph Layout view, zoom in/out of the graph, reset the Layout to its original state and expand/collapse all data in the viewer.

controllers

  • Use the Metadata Settings button to control which properties to view on the Metadata panel. Toggle on and off properties on each Object type and click Save.

image image

  • Multiple Datasets can be loaded at the same time, a new Graph Viewer Component will be opened for each dataset.

Multiple

Datasets Used

The SPARC SDS Viewer uses SPARC Portal datasets.

Error Handling

  • In the case of encountering an error, take a screenshot and report it with us please by opening an issue-clicking the Bug icon will take you to this page. If you don't have a GitHub account, please feel free to use the SPARC Contact form to provide your feedback.
  • To go back , click on the 'x' to go back to the previous screen.