Datasets: Difference between revisions
Mmaciejewski (talk | contribs) |
Mmaciejewski (talk | contribs) |
||
Line 40: | Line 40: | ||
==== Display Name/ Dataset Name==== | ==== Display Name/ Dataset Name==== | ||
While the user may control which metadata columns are visible, and in which order, the '''Display Name''' column is fixed as the first column. The '''Display Name''' is automatically set to the '''Dataset Name''' which is not-editable and is defined as the experimental directory name when the data was collected. For VNMRJ it is the exp''N'' directory name and for Bruker it is the experiment/''N'' directory. The '''Display Name''' is user editable allowing the user to create a more meaningful name than the VNMRJ or Topspin software allows, while keeping the original '''Dataset Name''' fixed. | While the user may control which metadata columns are visible, and in which order, the '''Display Name''' column is fixed as the first column. The '''Display Name''' is automatically set to the '''Dataset Name''' which is not-editable and is defined as the experimental directory name when the data was collected. For VNMRJ it is the exp''N'' directory name and for Bruker it is the experiment/''N'' directory. The '''Display Name''' is user editable allowing the user to create a more meaningful name than the VNMRJ or Topspin software allows, while keeping the original '''Dataset Name''' fixed. | ||
When a user '''downloads an experiment''', it will be saved using the '''Dataset Name''' (original experiment name). | When a user '''downloads an experiment''', it will be saved using the '''Dataset Name''' (original experiment name). | ||
* The corresponding '''Display Name''' can be found in a '''CSV file''' located in the downloaded experiment’s folder. | * The corresponding '''Display Name''' can be found in a '''CSV file''' located in the downloaded experiment’s folder. | ||
---- | ---- | ||
==== How to customize the Datasets Table view ==== | ==== How to customize the Datasets Table view ==== | ||
To customize the view of the Datasets Table | To customize the view of the Datasets Table |
Revision as of 17:14, 29 April 2025
Data Browser Overview
The Data Browser web application allows users to explore and manage datasets they are authorized to access. Access permissions are granted either due to the data being public or through lab-based, user-based, or collaborative access authorized by a Principal Investigator (PI). The navigation window on the left-hand side provides structured access to these datasets.
- All Datasets
- Displays every dataset the user can access, including both public datasets and restricted datasets the user has permission to view through lab membership or collaboration.
- All Public Datasets
- Displays only datasets that have been marked as public, regardless of any user-specific permissions.
- Knowledgebase Datasets
- Displays a curated subset of public datasets designated as *Knowledgebase (KB) datasets*.
- KB datasets are well-vetted, highly annotated datasets intended to aid users in running their own experiments and analyses.
- My & Lab Data (Default View)
- Displays datasets the user can view based on their PI-granted permissions.
- *Excludes* datasets that are visible *only* because they are public.
- If a dataset is public but the user would have had permission to see it regardless, it remains visible here.
Hierarchical Organization under My & Lab Data
The My & Lab Data section organizes user-accessible datasets hierarchically:
- My Collections
- Personal collections created and managed by the user.
- Projects
- High-level organizational units defined by the lab.
- Studies
- Subsets of Projects, grouping datasets for specific investigations.
- Collections
- Fine-grained dataset groupings within a Study.
This structure mirrors a traditional file system hierarchy: Project → Studies → Collections
Dataset Table
The Dataset Table displays all the datasets that the user has at least read access. The datasets are shown as a table with user adjustable columns representing metadata associated with the datasets.
Display Name/ Dataset Name
While the user may control which metadata columns are visible, and in which order, the Display Name column is fixed as the first column. The Display Name is automatically set to the Dataset Name which is not-editable and is defined as the experimental directory name when the data was collected. For VNMRJ it is the expN directory name and for Bruker it is the experiment/N directory. The Display Name is user editable allowing the user to create a more meaningful name than the VNMRJ or Topspin software allows, while keeping the original Dataset Name fixed. When a user downloads an experiment, it will be saved using the Dataset Name (original experiment name).
- The corresponding Display Name can be found in a CSV file located in the downloaded experiment’s folder.
How to customize the Datasets Table view
To customize the view of the Datasets Table
- Click on the "Wrench" Icon in the top-right corner of the table
- Click on the "Displayed Columns" button and select which columns you want to be visible in the Datasets Table
- Click the "Save View" button
- The saved views can be edited and deleted
- The user can create multiple views
- To switch between different views click on the "Saved Views" button
How to download experiments
To download experiments
- Navigate to the Datasets section of the Data Browser
- Locate the experiments you want to download
- Click the "Checkbox" icon to select multiple experiments.
- Alternatively, right-click on a single experiment to automatically select it
- Right-click and select "Download" option form the context menu
- Choose data organization format:
- Organized for Topspin
- If the datasets are in Bruker format you can download it structured for Topspin
- The Topspin hierarchy of the data, including all folders/subfolders, will be preserved
- Organized by experiment
- Each experiment will be in a separate folder
- Organized for Topspin
How to link datasets to a sample
There are two ways of linking datasets to a sample.
- Through editing the dataset
- Double click on the dataset that you have write access to
- In the appeared pop-up window, click on "Find & Link Sample"
- Choose the sample from the table of available samples
- Click "Save" to confirm the link
- Through Datasets Table
- Select one or more experiments you wish to link to a sample
- Right-click and choose "Link sample" option form the context menu
- Choose the sample from the table of available samples
- Click "Save" to confirm the link
Quick Filters
Quick filters are predefined views that allows users to quickly access specific datasets. The user can apply one or more filters:
- Successful Datasets Only – displays datasets classified as successful
- To classify a dataset, right-click on it and select "Classification" from the context menu
- Hide Failed Datasets – hides datasets that were classified as failed
- Non-Redundant Datasets – displays datasets marked as preferred
- To mark a dataset as preferred/redundant, right-click on it and select "Redundancy" from the context menu
- My Data – displays datasets owned by the logged-in user
- Non-public Data – displays datasets that have not been made public
- KB Datasets - display datasets that have been published in a knowledgebase
Right-clicking on a dataset opens the Context menu which provides various actions that users can perform on the selected dataset. The available options depend on the user's permissions for that dataset, options that are not allowed will appear grayed out. The options might include:
- Edit Dataset
- Change basic information about the dataset
- Mark dataset as preferred/redundant
- Reassign
- Reassign dataset to another user within the lab
- Reject misaligned data
- User has three months to reject the data
- The rejected data are automatically assigned to the facility manager of the facility in which the dataset was collected
- Download - download selected datasets
- NMRbox Integration - copy the dataset to NMRbox
- Supplemental Data - upload supplemental data
- Redundancy - mark a dataset as preferred/redundant
- Link Sample - link the dataset to the sample that has been created in the Samples section of the Data Browser
- Name of the sample and a link to its information will appear in the Sample Column of Datasets Table
- Classification - classify dateset as
- Calibration experiment
- Failed - sample related
- Failed - instrument related
- Failed - setup related
- Succesful Experiment
- Test experiment
- Tags - assign tags to categorize the dataset
- Notes - add or update dataset notes
- Unlink from Collection - if the dataset is linked to a Dataset Collection, the user can unlink it
- Make Public - make the dataset public. This is a PERMANENT option and can't be undone.
- Publish - publish dataset. The published datasets can't be edited. This is a PERMANENT option and can't be undone.