Self-deposit guide
This guide assumes that you have a dataset which conforms to the current BIDS specification.
Read this guide until the end before you start depositing your data.
Additionally to BIDS, your dataset should satisfy the ANC's Data Format Requirements. Please verify that. If you have any problems with satisfying the requirements, have a look at our Data Formatting Guides.
The ANC is built with GitLab which uses Git for version control. Although our guides explain the commands and functionalities of these systems, you should have basic skills in Git and shell usage, for example bash.
Create an Austrian NeuroCloud account
To deposit your data you need an ANC account.
You accept the ANC Terms of Use
By creating the ANC account and signing in into the system, you accept the ANC Terms. In particular, as depositor you accept the Transfer and License Agreement and agree to license your dataset with the ANC License.
Create a Dataset Project
Every dataset project belongs to a research unit group in BIDS Datasets. If you don't find your research unit group, please ask to create the group for you by sending an email to anc@plus.ac.at
including: your user name, the full name of the group, its abbreviated name used in URLs, and a description.
Once your research unit group is available, create a new dataset project.
Understand the dataset project files
A new dataset project comes with several predefined files. Please make yourself familiar with them.
Data curation and stewardship
Curation of your dataset, including editing metadata as well as adding participant data, usually follows the Basic GitLab workflow. Issues (Plan > Issues) define the work that should be done for your dataset. Some issues are already there for you to start.
The ANC data stewards assist you in the data deposition and review changes to your data. Moreover, they learn your data in the process, help you resolve any issues, and offer metadata improvements.
The "Dataset Status" issue, labeled Dataset statusInitialized, specifies the data steward assigned to your dataset (Asignee) and serves as a communication channel with your data steward. Leave a comment there if you need any help.
ANC Task issues and metadata
A fresh dataset project comes with several predefined ANC Task issues, labeled ANC Task*, which guide you through adding metadata to your dataset. The descriptions of the issues provide you with the necessary instructions and links to further documentation. Always read the description before you start working.
Resolve the ANC Task issues following our workflows for working with data.
Add participant data files
Every dataset is different. To tailor the ANC functionalities to your dataset, the data steward needs to understand your data. Therefore, we divide the process of depositing participant data in two.
Adding participant data follows Basic GitLab workflow with Step 3 executed on the machine where your data resides.
Pilot participant
Pick one participant with the most complete data. In this step you add all data relevant only to this participant, including:
- participant data files (excluding phenotype-only datasets): the entire
sub-
directory of the chosen participant, - participant metadata: one row in
participants.tsv
file for the chosen participant and the missing column descriptions in theparticipants.json
file (for more information see your project's issue with ANC Task9 label).
Create a new issue with a descriptive title, for example "Pilot participant", and briefly describe the expected participant data: sessions, data types, number of scans, participant information, etc.
Mandatory session directories
The ANC requires every participant directory to have at least one session.
Create a merge request and follow the local workflow to add participant files.
Add imaging data files using git commands locally
Use the local workflow to deposit participant data. Imaging files are stored using Git LFS, which is not available in GitLab's WebIDE.
This is a known GitLab issue.
After pushing all data files, view the changes in the merge request and request a review and data merge from your data steward. Please give your data steward some time to respond.
The data steward will assist you with the merge request, ask for potential clarifications, recommend necessary changes, or ask for more pilot participants if necessary.
After completed review, the data of your pilot participant will be merged
Remaining participants
Continue with this step only after the data of your pilot participant has been merged in.
Follow the steps of the Pilot participant. This time you can add the data of all the remaining participants.
Do not add too many participants at once
The ANC can handle large amount of data. However, to keep the system responsive and simplify the interaction with the data stewards, consider adding the participants in batches.
Questionnaire data
We recommend to add questionnaire data after all participant data has been deposited.
Follow the steps in you project's issue "Add Questionnaire Data" labeled ANC Task45.