Supplemental Data - Revision history

Mmaciejewski at 17:06, 10 June 2025

2025-06-10T17:06:34Z

← Older revision		Revision as of 17:06, 10 June 2025
Line 1:		Line 1:
	~~<span style="display:inline-block; margin-bottom:1em;">[[~~Datasets~~#Actions\|← Back to Dataset Browser --> Actions]]</span>~~		{{Datasets}}

	== Overview ==		== Overview ==

Mmaciejewski: /* Adding Supplemental Data */

2025-05-28T13:59:37Z

Adding Supplemental Data

← Older revision		Revision as of 13:59, 28 May 2025
Line 11:		Line 11:

	== Adding Supplemental Data ==		== Adding Supplemental Data ==
	[[File:Supplemental Data Modal.png\|thumb\|Supplemental Data Modal\|~~450x450px~~]]		[[File:Supplemental Data Modal.png\|thumb\|Supplemental Data Modal\|600x600px]]
	Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu. Entries in the supplemental data table require the following fields:		Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu. Entries in the supplemental data table require the following fields:

Mmaciejewski: /* Adding Supplemental Data */

2025-05-28T13:58:58Z

Adding Supplemental Data

← Older revision		Revision as of 13:58, 28 May 2025
Line 11:		Line 11:

	== Adding Supplemental Data ==		== Adding Supplemental Data ==
	[[File:Supplemental Data Modal.png\|thumb\|Supplemental Data Modal]]		[[File:Supplemental Data Modal.png\|thumb\|Supplemental Data Modal\|450x450px]]
	Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu. Entries in the supplemental data table require the following fields:		Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu. Entries in the supplemental data table require the following fields:

Mmaciejewski: /* Adding Supplemental Data */

2025-05-28T13:58:22Z

Adding Supplemental Data

← Older revision		Revision as of 13:58, 28 May 2025
Line 11:		Line 11:

	== Adding Supplemental Data ==		== Adding Supplemental Data ==
			[[File:Supplemental Data Modal.png\|thumb\|Supplemental Data Modal]]
	Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu. Entries in the supplemental data table require the following fields:		Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu. Entries in the supplemental data table require the following fields:

Mmaciejewski: /* Supplemental Data via Download */

2025-05-28T13:44:39Z

Supplemental Data via Download

← Older revision		Revision as of 13:44, 28 May 2025
Line 39:		Line 39:

	== Supplemental Data via Download ==		== Supplemental Data via Download ==
	Supplemental data entries become part of the dataset record, and any uploaded files are stored in a dedicated `supplemental_data` directory within the dataset. These entries and files are included in the downloadable dataset archive. In addition, a supplemental_data.csv file is stored in the dataset with a full list of all supplemental data entries. See the [~~https://wiki.usnan.org/index.php?title=Download_Datasets&veaction=edit&section=6~~ Downloads] section for full details.		Supplemental data entries become part of the dataset record, and any uploaded files are stored in a dedicated `supplemental_data` directory within the dataset. These entries and files are included in the downloadable dataset archive. In addition, a supplemental_data.csv file is stored in the dataset with a full list of all supplemental data entries. See the [[Download Datasets\|Downloads]] section for full details.

Mmaciejewski: /* Supplemental Data via Download */

2025-05-28T13:43:02Z

Supplemental Data via Download

← Older revision		Revision as of 13:43, 28 May 2025
Line 39:		Line 39:

	== Supplemental Data via Download ==		== Supplemental Data via Download ==
	Supplemental data entries become part of the dataset record, and any uploaded files are stored in a dedicated `supplemental_data` directory within the dataset. These entries and files are included in the downloadable dataset archive. In addition, a supplemental_data.csv file is stored in the dataset with a full list of all supplemental data entries.		Supplemental data entries become part of the dataset record, and any uploaded files are stored in a dedicated `supplemental_data` directory within the dataset. These entries and files are included in the downloadable dataset archive. In addition, a supplemental_data.csv file is stored in the dataset with a full list of all supplemental data entries. See the [https://wiki.usnan.org/index.php?title=Download_Datasets&veaction=edit&section=6 Downloads] section for full details.

Mmaciejewski at 13:39, 28 May 2025

2025-05-28T13:39:36Z

← Older revision		Revision as of 13:39, 28 May 2025
Line 1:		Line 1:
			<span style="display:inline-block; margin-bottom:1em;">[[Datasets#Actions\|← Back to Dataset Browser --> Actions]]</span>

	== Overview ==		== Overview ==
	NAN enables users to enrich archived datasets with additional context and information through the use of supplemental data. While NDTS harvests all files present in an experimental dataset—including waveform files, pre-compiled pulse programs, and other required components—certain files and metadata relevant to downstream use may not be available at the time of data collection.		NAN enables users to enrich archived datasets with additional context and information through the use of supplemental data. While NDTS harvests all files present in an experimental dataset—including waveform files, pre-compiled pulse programs, and other required components—certain files and metadata relevant to downstream use may not be available at the time of data collection.

Mmaciejewski: /* Supplemental Data */

2025-05-28T13:38:14Z

Supplemental Data

← Older revision		Revision as of 13:38, 28 May 2025
Line 1:		Line 1:
	= ~~Supplemental Data~~ =		== Overview ==

	NAN enables users to enrich archived datasets with additional context and information through the use of supplemental data. While NDTS harvests all files present in an experimental dataset—including waveform files, pre-compiled pulse programs, and other required components—certain files and metadata relevant to downstream use may not be available at the time of data collection.		NAN enables users to enrich archived datasets with additional context and information through the use of supplemental data. While NDTS harvests all files present in an experimental dataset—including waveform files, pre-compiled pulse programs, and other required components—certain files and metadata relevant to downstream use may not be available at the time of data collection.

	These may include:		These may include:
	* Protocols		* Protocols
	* ~~Data processing and analysis scripts~~		* Scripts
	* ~~Links to external databases such as BMRB~~		* Identifiers
	* ~~Additional experimental metadata~~		* Files

	== Adding Supplemental Data ==		== Adding Supplemental Data ==

	Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu ~~(see ''Figure 8'')~~. Entries in the supplemental data table require the following fields:		Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu. Entries in the supplemental data table require the following fields:

	* '''Category'''		* '''Category'''
Line 17:		Line 16:
	* '''Value'''		* '''Value'''
	* '''(Optional) Description'''		* '''(Optional) Description'''
			'''Types''' include:
	~~Supported types~~ include:
	* URLs		* URLs
	* File uploads		* File uploads
Line 24:		Line 22:
	* External ID numbers		* External ID numbers

	~~Supported categories~~ include:		'''Categories''' include:
	* '''Protocols''' – Instrument setup, sample preparation, pulse program setup, signal processing, and analysis		* '''Protocols''' – Instrument setup, sample preparation, pulse program setup, signal processing, and analysis
	* '''Scripts''' – Experimental setup, signal processing, and analysis		* '''Scripts''' – Experimental setup, signal processing, and analysis
	* '''Identifiers''' – BMRB, PDB, Metabolomics Workbench, DOIs		* '''Identifiers''' – BMRB, PDB, Metabolomics Workbench, DOIs
	* '''Data Files''' – Sample schedules, experimental parameters, pulse programs, processed data, sample parameters		* '''Data Files''' – Sample schedules, experimental parameters, pulse programs, processed data, sample parameters
			'''Values''' are user entered and must conform to the type. For example, URLs must be valid, BMRB and PDB IDs must be in the correct format, etc.

	Supplemental entries become part of the dataset record, and any uploaded files are stored in a dedicated `supplemental_data` directory within the dataset. These entries and files are included in the downloadable dataset archive.		The '''description''' field is optional

	== Supplemental Data in the Data Browser ==		== Supplemental Data in the Data Browser ==
Line 37:		Line 36:
	* A ''Supplemental Data'' column in the browser table supports filtering and sorting based on presence of supplemental data.		* A ''Supplemental Data'' column in the browser table supports filtering and sorting based on presence of supplemental data.

	== ~~Integration with NMRbox~~ ==		== Supplemental Data via Download ==
			Supplemental data entries become part of the dataset record, and any uploaded files are stored in a dedicated `supplemental_data` directory within the dataset. These entries and files are included in the downloadable dataset archive. In addition, a supplemental_data.csv file is stored in the dataset with a full list of all supplemental data entries.
	~~NAN and NMRbox share a common~~ data ~~infrastructure~~, ~~enabling seamless dataset transfers. Users may copy datasets from the NAN browser to their NMRbox home folder using the context menu. These transfers~~ are ~~tracked~~ within the ~~NAN database~~.

	~~If users generate new~~ files in ~~their NMRbox post-acquisition directory (e~~.g.~~, processed or analyzed data), they may use the '''Retrieve Post-Acquisition Data''' action to append these files back into~~ the ~~corresponding NAN~~ dataset ~~archive as~~ supplemental data.

Mmaciejewski: Created page with "= Supplemental Data = NAN enables users to enrich archived datasets with additional context and information through the use of supplemental data. While NDTS harvests all files present in an experimental dataset—including waveform files, pre-compiled pulse programs, and other required components—certain files and metadata relevant to downstream use may not be available at the time of data collection. These may include: * Protocols * Data processing and analysis scri..."

2025-05-28T13:22:06Z

Created page with "= Supplemental Data = NAN enables users to enrich archived datasets with additional context and information through the use of supplemental data. While NDTS harvests all files present in an experimental dataset—including waveform files, pre-compiled pulse programs, and other required components—certain files and metadata relevant to downstream use may not be available at the time of data collection. These may include: * Protocols * Data processing and analysis scri..."

New page

= Supplemental Data =

NAN enables users to enrich archived datasets with additional context and information through the use of supplemental data. While NDTS harvests all files present in an experimental dataset—including waveform files, pre-compiled pulse programs, and other required components—certain files and metadata relevant to downstream use may not be available at the time of data collection.

These may include:
* Protocols
* Data processing and analysis scripts
* Links to external databases such as BMRB
* Additional experimental metadata

== Adding Supplemental Data ==

Supplemental data may be appended to individual datasets or dataset collections via a dedicated modal launched from the Dataset Editor or the dataset context menu (see ''Figure 8''). Entries in the supplemental data table require the following fields:

* '''Category'''
* '''Type'''
* '''Value'''
* '''(Optional) Description'''

Supported types include:
* URLs
* File uploads
* Existing files within the dataset
* External ID numbers

Supported categories include:
* '''Protocols''' – Instrument setup, sample preparation, pulse program setup, signal processing, and analysis
* '''Scripts''' – Experimental setup, signal processing, and analysis
* '''Identifiers''' – BMRB, PDB, Metabolomics Workbench, DOIs
* '''Data Files''' – Sample schedules, experimental parameters, pulse programs, processed data, sample parameters

Supplemental entries become part of the dataset record, and any uploaded files are stored in a dedicated `supplemental_data` directory within the dataset. These entries and files are included in the downloadable dataset archive.

== Supplemental Data in the Data Browser ==

* Datasets with supplemental data are marked with a special icon badge.
* A ''Supplemental Data'' column in the browser table supports filtering and sorting based on presence of supplemental data.

== Integration with NMRbox ==

NAN and NMRbox share a common data infrastructure, enabling seamless dataset transfers. Users may copy datasets from the NAN browser to their NMRbox home folder using the context menu. These transfers are tracked within the NAN database.

If users generate new files in their NMRbox post-acquisition directory (e.g., processed or analyzed data), they may use the '''Retrieve Post-Acquisition Data''' action to append these files back into the corresponding NAN dataset archive as supplemental data.