Datasets: Difference between revisions

From Network for Advanced NMR
Jump to navigationJump to search
No edit summary
No edit summary
Line 10: Line 10:


== Navigation Pane ==
== Navigation Pane ==
The Navigation Bar allows users to quickly access datasets across different categories. Unauthenticated users will only see ''All Public Datasets'' and ''Knowledgebase Datasets''.
The Navigation Pane allows users to quickly access datasets across different categories. Unauthenticated users will only see ''All Public Datasets'' and ''Knowledgebase Datasets''.
; '''All Datasets'''
 
=== All Datasets ===
: Displays all datasets the user can access, including public and permission-granted datasets.
: Displays all datasets the user can access, including public and permission-granted datasets.
; '''All Public Datasets'''
 
=== '''All Public Datasets''' ===
: Displays only datasets marked as public.
: Displays only datasets marked as public.
; '''Knowledgebase Datasets'''
 
=== '''Knowledgebase Datasets''' ===
: Displays a curated subset of public datasets that are highly annotated and intended to aid users in experimental planning and analysis.
: Displays a curated subset of public datasets that are highly annotated and intended to aid users in experimental planning and analysis.
; '''My & Lab Data'''
 
: Displays datasets accessible via user- or lab-based permissions (excluding datasets that are visible only due to being public).
=== '''My & Lab Data''' ===
: Displays datasets accessible via user- or lab-based permissions (excluding datasets that are visible only due to being public).
: This section includes a hierarchical organization mirroring a file system:
: This section includes a hierarchical organization mirroring a file system:
:* '''My Collections''' – personal collections created by the user.
:* '''My Collections''' – personal collections created by the user.
:* '''Projects''' – high-level lab groupings.
:* '''Projects''' – high-level groupings for data organization
::* '''Studies''' – project subsets for specific investigations.
::* '''Studies''' – reside inside Projects to allow datasets from a given study to be grouped
:::* '''Collections''' – fine-grained dataset groupings within a study.
:::* '''Collections''' – reside inside Studies to allow fine-grained dataset groupings


== Table of Datasets ==
== Table of Datasets ==
The Dataset Table displays all datasets for which the user has at least ''read access''. Each row represents one dataset, with metadata columns that can be customized per user.
The Dataset Table displays all datasets for which the user has at least ''read access''.  
 
=== Table Rows ===
Each row highlights a dataset in the NAN archive
 
=== Table Columns ===
Columns represent different metadata fields for the NAN dataset. There is a default list of columns that are displayed, but users can toggle different columns on and off as desired by selecting the wrench icon in the upper right hand corner of the dataset browser. Columns may be re-order by dragging them. The columns to be displayed, along with their order, is saved in the NAN database as a user preference and will persist across sessions, browsers, and computers. See [[Dataset Columns]] for a complete list of columns with a short description.
 
==== Display Name / Dataset Name ====
When a dataset is harvested by the NAN Data Transport System it is stored in the NAN database with a unique UUID (hidden from the user) and is given a Dataset Name (non-editable) that matches the experimental directory from the NMR spectrometer.
* VNMRJ: `exp''N''`
* Bruker: `experiment/''N''`
As the Dataset Name is generally not a useful description of the experiment we also create a Display Name that is user editable to allow users to create a more descriptive and meaningful label. When downloading, the dataset is saved using the original '''Dataset Name''' and the the '''Display Name''' is saved in a CSV file within the dataset folder. Note that the Display Name is fixed as the first column of the dataset table and cannot be altered. The Data Name column is not displayed by default, but can be toggled on if desired.
 
==== Icon badges ====
 
=== Pagination ===
At the bottom of the table is a '''pagination control'''. Users can move between pages and adjust the number of rows displayed per page: '''25''', '''50''', '''100''', or '''500''' datasets per page.
At the bottom of the table is a '''pagination control'''. Users can move between pages and adjust the number of rows displayed per page: '''25''', '''50''', '''100''', or '''500''' datasets per page.
=== Display Name / Dataset Name ===
The '''Display Name''' is the first column and is always visible. It defaults to the non-editable '''Dataset Name''', which corresponds to the experiment directory name:
* VNMRJ: `expN`
* Bruker: `experiment/N`
Users can edit the '''Display Name''' to create a more meaningful label. When downloading, the dataset is saved using the original '''Dataset Name'''; the '''Display Name''' is saved in a `CSV` file within the downloaded folder.


----
----

Revision as of 17:55, 22 May 2025

Data Browser: Datasets

The Dataset Browser allows users to explore and manage datasets they are authorized to access. Access permissions are granted either because the dataset is public or through lab-based, user-based, or collaborative permissions authorized by a Principal Investigator (PI).

The Dataset Browser includes:

  • A Navigation Pane on the left side for switching between dataset views and hierarchical organization of My & Lab data described below.
  • A Table View for displaying rows of datasets with columns representing metadata that may be sorted and filtered.
  • Customization Tools in the upper-right corner to configure columns, saved views, and filters.
  • An Upload Datasets button to submit datasets that were not harvested by NDTS.

Navigation Pane

The Navigation Pane allows users to quickly access datasets across different categories. Unauthenticated users will only see All Public Datasets and Knowledgebase Datasets.

All Datasets

Displays all datasets the user can access, including public and permission-granted datasets.

All Public Datasets

Displays only datasets marked as public.

Knowledgebase Datasets

Displays a curated subset of public datasets that are highly annotated and intended to aid users in experimental planning and analysis.

My & Lab Data

Displays datasets accessible via user- or lab-based permissions (excluding datasets that are visible only due to being public).
This section includes a hierarchical organization mirroring a file system:
  • My Collections – personal collections created by the user.
  • Projects – high-level groupings for data organization
  • Studies – reside inside Projects to allow datasets from a given study to be grouped
  • Collections – reside inside Studies to allow fine-grained dataset groupings

Table of Datasets

The Dataset Table displays all datasets for which the user has at least read access.

Table Rows

Each row highlights a dataset in the NAN archive

Table Columns

Columns represent different metadata fields for the NAN dataset. There is a default list of columns that are displayed, but users can toggle different columns on and off as desired by selecting the wrench icon in the upper right hand corner of the dataset browser. Columns may be re-order by dragging them. The columns to be displayed, along with their order, is saved in the NAN database as a user preference and will persist across sessions, browsers, and computers. See Dataset Columns for a complete list of columns with a short description.

Display Name / Dataset Name

When a dataset is harvested by the NAN Data Transport System it is stored in the NAN database with a unique UUID (hidden from the user) and is given a Dataset Name (non-editable) that matches the experimental directory from the NMR spectrometer.

  • VNMRJ: `expN`
  • Bruker: `experiment/N`

As the Dataset Name is generally not a useful description of the experiment we also create a Display Name that is user editable to allow users to create a more descriptive and meaningful label. When downloading, the dataset is saved using the original Dataset Name and the the Display Name is saved in a CSV file within the dataset folder. Note that the Display Name is fixed as the first column of the dataset table and cannot be altered. The Data Name column is not displayed by default, but can be toggled on if desired.

Icon badges

Pagination

At the bottom of the table is a pagination control. Users can move between pages and adjust the number of rows displayed per page: 25, 50, 100, or 500 datasets per page.


How to Customize the Dataset Table View

  1. Click the Wrench icon in the top-right corner.
  2. Choose Displayed Columns to select which columns are visible.
  3. Use Save View to save your configuration.
    • Views can be edited or deleted.
  4. Use Saved Views to switch between existing configurations.

How to Download Experiments

  1. Select one or more experiments using the checkbox icon or by right-clicking.
  2. Right-click and choose Download.
  3. Select the download format:
    • Organized for Topspin – maintains Bruker format hierarchy.
    • Organized by Experiment – each experiment in its own folder.

How to Link Datasets to a Sample

There are two ways:

  1. From the Dataset Editor
    • Double-click a dataset you have write access to.
    • Click Find & Link Sample, select a sample, and click Save.
  1. From the Table View
    • Select datasets, right-click, and choose Link Sample.
    • Select a sample and click Save.

Quick Filters

Quick filters apply predefined views to narrow down datasets:

  • Successful Datasets Only – shows datasets marked as successful.
  • Hide Failed Datasets – hides datasets marked as failed.
  • Non-Redundant Datasets – shows datasets marked as preferred.
  • My Data – datasets owned by the logged-in user.
  • Non-public Data – datasets not made public.
  • KB Datasets – datasets published in the Knowledgebase.

To classify or mark datasets:

  • Right-click the dataset and select Classification or Redundancy from the context menu.

Context Menu

Right-clicking a dataset opens the context menu. Available actions depend on the user’s permissions; unavailable actions appear grayed out.

Available options may include:

  1. Edit Dataset
    • Update metadata, classification, or redundancy status.
  2. Reassign
    • Assign to another lab user or reject misaligned data.
    • Rejected data (within 3 months) goes to the facility manager.
  3. Download
    • Download dataset(s).
  4. NMRbox Integration
    • Copy dataset to NMRbox home directory.
  5. Supplemental Data
    • Upload related data files.
  6. Redundancy
    • Mark as preferred/redundant.
  7. Link Sample
    • Associate with a sample (shows up in the Sample column).
  8. Classification
    • Label as:
      • Calibration experiment
      • Failed – sample, instrument, or setup related
      • Successful experiment
      • Test experiment
  9. Tags
    • Add searchable tags.
  10. Notes
    • Add or edit descriptive notes.
  11. Unlink from Collection
    • Remove from a dataset collection.
  12. Make Public
    • Permanently make dataset public (cannot be undone).
  13. Publish
    • Permanently publish dataset (cannot be undone or edited).