Steps for submitting a dataset
This documentation only applies to investigators that are funded throught the NIH SPARC effort. Each investigator has user-credentials under the account SPARC Consortium on the DAT-Core. All datasets that are SPARC related should be submitted to this account even though the investigator might have an separate private Blackfynn account. Dataset submission is required within 30 days of completing a project milestone (according to the SPARC Material Sharing Policy).
1. Creating a draft dataset
There are a couple of easy steps to submit a dataset:
Create a dataset on the DAT-Core (SPARC Consortium account on Blackfynn) by clicking the
New Datasetbutton in the top-right corner of the webapplication and provide a Dataset Name and a short Dataset Subtitle describing the dataset. Then, click on
Create Dataset. You now created a private dataset that only you, as the dataset owner, can see.
Change the ownership of the dataset to the PI of the lab. This is a SPARC requirement and ensures that the PI is the only person who can publish the dataset. To do this, click on the
Permissionstab, and add the PI to your dataset as a manager. Then click on the
managerlabel next to his/her name and select
Make Owner. You will no longer be the owner of the dataset, but still have manager permissions.
Add permissions to your Award team (contact the DAT-Core if you need help adding people to your award team) and the Curation team. Select your award-team from the dropdown menu, and add with the appropriate permissions, and add the SPARC Data Curation Team with manager permissions. You have now allowed your award-team and the curation team to see, and edit the dataset.
Upload files to the dataset according to the SPARC guidelines. The SPARC Dataset Structure (version 1.2.3) may be downloaded as a zip file or you may create it on your own. For help with working with the SPARC Dataset Structure, which is based on the BIDS specification, contact email@example.com. More information on how to upload files can be found here Complete the metadata templates that are included in the downloadad SPARC Dataset Structure zip-file. Experimental metadata specified by the SPARC Data Standards Committee based on the Minimal Information for a Neuroscience Dataset (MINDS) specification and are captured in the following files: 1) submission.xlsx, 2) dataset_description.xlsx, 3) subjects.xlsx, and 4) samples.xlsx. An annotated list of these fields can be found here.
Provide a detailed description of your dataset using the description editor on the DAT-Core. This description will be highly visible once your dataset is published.
Add a nice banner image that will be associated with the dataset and will be visisble once the dataset is published. Click on the
Upload Banner Imagein the
Select a license that you want to associate with the dataset once published. Click on the
licensedropdown menu in the
Finally, you will need to submit a protocol to Protocols.io as part of the SPARC group.
NOTE: There are other things that need to be entered into the DAT-Core before a dataset can be published such as: 1) the contributors, and 2) a list of tags. However, the curation team will help with adding these to the dataset from the CSV templates that you will provide as part of the uploaded files.
NOTE: You are free to add additional metadata in the DAT-Core Metadata database. If you do this, do not use the following model names: 1) Term, 2) Subject, 3) Protocol, 4) Researcher, 5) Summary, or 6) Sample as these will be overritten by the SPARC curation process.
2. Placing your data in Embargo
Now that you have created a dataset and you are ready for the data curation to help with further curation and validation of the data, you need to share your data with the rest of the consortium.
- Add the SPARC Embargoed Data Sharing Team to your dataset with viewer permissions. This allows any SPARC investigator who has signed the SPARC Non-disclosure form to see your data.
3. Publishing your dataset
When the dataset is ready to be published, the dataset owner can publish the dataset and make it publicly available. There are two steps required for dataset publication: 1) Protocol publication on Protocols.io, and 2) Dataset Publication on the DAT-Core.
Make your protocol public on Protocols.io The first step to making your data public is to make sure your protocols are made public on Protocols.io. Perform the following steps:
Log into protocols.io, and publish your dataset’s protocol(s) by clicking the orange PUBLISH button.
Get a DOI for your protocol by clicking the orange GET DOI button.
Give the curators a couple days to update your protocol URL to the DOI in your dataset_description file, or go ahead and do it yourself. To do it yourself, update the URL(s) to your protocol(s) by editing the Blackfynn “Protocol” metadata record.
Update the protocol record(s) in the DAT-Core to correctly store the newly generated DOI. To do this, click on the
Recordstab in the dataset, and select the
protocolmodel if this exist. Then, click on the protocol that you want to update and click the
editbutton. Update the
URLfield with the correct DOI URL anc click on
Upon receiving confirmation from the curation team that your dataset has been fully curated and is ready to publish, continue to the steps below.
Make your dataset public on the DAT-Core Publishing your Blackfynn datasets will make your data publicly available for the world to see. The dataset will be findable and accessible on Blackfynn Discover and the SPARC Portal.
Make sure the following information is correct for the dataset:
- Dataset Title
- Dataset SubTitle
- Dataset Describtion
- Dataset Contributors
- Dataset Tags
- Dataset License (must select CC-BY license, per SPARC policy)
- The Banner Image (.jpg or .png)
- The URLS in the Protocol records.
Go to the Settings tab for the dataset on the DAT-Core.
Have the owner of the dataset click on
Publish to Blackfynn Discoverbutton. It is required for the owner to have an ORCID ID associated with their user-profile. Publishing a dataset will automatically request a Data Object Identifier (DOI) through DataCite if you had not reserved one before. You can always publish an updated version of the dataset if needed at a later time, or un-publish a dataset if needed.
This document outlined the steps required to submit and publish a SPARC dataset. Please feel free to reach out to the DAT-Core or Curation team with specific questions about the workflow.