Contributing to 1HMRS-VERI
Data submission procedure
1HMRS-VERI data sets are accessible from a dedicated page on MRSHub.
Please read the 1HMRS-VERI guidelines to submission for an explanation of the types and necessary components of the data acceptable for this project.
Once the dataset itself is prepared, its submission to 1HMRS-VERI consist of two parts:
1) Your SUBMISSION.md Markdown file
This is a description of your submitted data, including a link to the data set itself, also used by any MRSHub submission. You can download a template SUBMISSION.md here.
| Field | Mandatory? | Description |
|---|---|---|
| Developer | Yes | The name(s) you want to credit |
| Name of dataset | Yes | The name of the dataset |
| Abstract | Yes | A brief description of the dataset you contribute |
| Type | Yes | The type of data. We recommend to pick one of these: svs (single-voxel MRS) or mrsi with either _phant (measurements in a phantom), _in vivo (in vivo measurements supported by non-1HMRS concentration estimates of at least one metabolite in the spectrum), _sim (simulated spectra or individual metabolites), or _comp (composite spectra with simulated metabolites and additional artifacts) |
| Format | Yes | The file formats used to store your 1) dataset spectra, 2) associated basis sets/functions, 3) ground truth metabolite values, 4) acquisition and simulation methodology, and 5) any additional information provided |
| Sequence | Yes | The MRS sequence(s) used to 1) acquire the dataset and 2) simulate any associated basis sets/functions |
| Credit | No | Indicate how you would like to be credited for your data–for example, if a certain publication should be cited, or whether you would like to be acknowledged in publications using your data |
| Contact | No | A way you can be contacted: an e-mail address, the website of your lab, your LinkedIn/ResearchGate/Google Scholar page. This information will be made available on MRSHub website, so if you would rather your e-mail not be made public, please do not include |
| Publication | No | A publication you want to associate with the submission |
| URL | Yes | A URL to the data set itself associated with the submission. The data may be hosted externally by the submitter (click here for MRSHub suggestions on hosting frameworks) or on the dedicated Open Science Framework (OSF) project for 1HMRS-VERI (latter preferred). If you choose to host your data on our OSF project, this field should include your OSF account name so that you can be granted access |
2) A LICENSE.md Markdown file
This is a text file describing the limitations on others’ use of your data. As per MRSHub policy, if this file is not explicitly provided, we will default to a BSD 3-clause license.
Please submit both SUBMISSION.md and LICENSE.md files as attachments by email with the subject line “1HMRS-VERI Data Submission.” If you choose to host your data on our OSF project instead of externally, please create an account on the Open Science Framework and include your account name in the data URL field of your SUBMISSION.md file.
Data privacy and compliance
Stripping private and protected information from all data sets submitted to 1HMRS-VERI is the sole responsibility of the parties who submit them. As per MRSHub policy, We assume no responsibility or liability for data that is improperly de-identified, or shared without institutional permission. Such data will be immediately removed. 1HMRS-VERI follows the MRSHub policy on data privacy and compliance, the full text of which is available here.