# Guide To Data Sharing

## Checklist and Steps

### Step 1: GIN account and In2PrimateBrains organization

Make sure you have a GIN profile and have joined the In2PrimateBrains organization. If not, follow the instructions in the [Data Platform](./documents/In2PB_DataPlatform.pdf) document.

### Step 2: Prepare your data for sharing

- Some general guidelines outlining the best practices for data organization are given in the [ Data Sharing Guidelines](./documents/In2PB_DataSharing_GuidingPrinciples.pdf) document.
- It is crucial that the contributed datasets are accompanied by as much metadata as possible. One can use the templates defined for the common localizer experiments [here](https://gin.g-node.org/In2PrimateBrains/CommonLocalizerMetadataTemplates). Detailed instructions on using these templates and creating instances can be found [here](https://gin.g-node.org/In2PrimateBrains/in2pb-metadata-instances) (under development). 
- Please contact ESR14 once you are ready to use these templates.
- In addition to structured metadata, it is also recommended to provide a detailed description of the data. You can use the [Data Descriptor](./documents/In2PB_DataDescriptor_v1.pdf) template for this purpose. It is based on the [Nature Scientific Data](https://www.nature.com/sdata/publish/for-authors#data-descriptors) principles. Please makecopy of the editable [document version](./documents/In2PB_DataDescriptor_v1.docx) and fill it out.

### Step 3: Data upload

Once the data is ready, follow the steps outlined in the [Data Upload Steps](./documents/In2PB_DataUpload_Steps.pdf) document for uploading the data to GIN. It is recommended to use the GIN client for uploading data. It is also recommended to prepare and upload the data in a repository under your personal account first and then transfer it to the In2PrimateBrains organization (see next step).
  
Some resources that could be useful for this step:
  - [Intro to GIN](https://gin.g-node.org/In2PrimateBrains/IntroToGIN): This repository gives a technical introduction to GIN, installation of the GIN client and some example usage scenarios.
  - [GIN Cheatsheet](./documents/GINCheatsheet.pdf): This is a printable cheatsheet with the most important GIN commands.
  - [GIN Wiki](https://gin.g-node.org/G-Node/info/wiki): This is the official GIN wiki with detailed information on how to use GIN.

### Step 4: Transfer of repository to In2PrimateBrains organization

Once the data is uploaded, please inform ESR14 so that the data can be reviewed and transferred to the In2PB organization.

### Step 5: Obtaining a DOI

If you wish to obtain a doi for your dataset, please contact ESR14. Additionally, you can find more information on how to obtain a DOI for your dataset [here](https://gin.g-node.org/G-Node/Info/wiki/DOI).


## More information

A detailed documentation of the data and metadata management workflows for In2PrimateBrains can be found here - [https://in2primatebrains.github.io/DataMetadataWorkflowDocs/](https://in2primatebrains.github.io/DataMetadataWorkflowDocs/) (under development). This website will be updated with the tools, methods and resources being used for data management and curation in the In2PrimateBrains project.