Wiki source code of test-ir2

Version 54.1 by spieschnik on 2023/04/25 15:36
Show last authors
1 == Publishing neuroscience data, models and software via EBRAINS ==
2
3 The aim of this collab is to provide you with all the information you need to publish your experimental data, simulations, computational models, and software via EBRAINS. Have you already published your data somewhere else? You can increase the exposure and impact of your shared dataset by also listing it on EBRAINS.
4
5 {{box title="**Contents**"}}
6 {{toc depth="3" start="2"/}}
7 {{/box}}
8
9
10 (% style="text-align: center;" %)
11 **Get started! **
12
13 (% style="text-align: center;" %)
14 **[[REQUEST CURATION>>https://nettskjema.no/a/277393#/]] **
15
16 (% style="text-align: center;" %)
17 Search existing data, models and software in [[the EBRAINS Knowledge Graph Search>>https://kg.ebrains.eu/search/?facet_type[0]=Dataset]]
18
19
20 ----
21
22 == **The EBRAINS curation process** ==
23
24 In EBRAINS, multimodal and heterogenous neuroscience data, models and software are categorised and described in a standardised manner so that they can be effectively searched, compared, and analysed. This effort is referred to as curation. 
25
26 >The EBRAINS curation process involves organising and annotating neuroscientific data to make the data discoverable and reusable.
27
28 Behind this process is the EBRAINS Curation team. Our mandate is to support you in sharing your data in line with the [[**FAIR principles**>>https://www.go-fair.org/fair-principles/]], whether you choose to describe only the key aspects of your data, or can invest in adding more detailed metadata.
29
30 === About the curation team ===
31
32 [[image:fb6d6429-709e-4f4d-be3b-eab0a46695bd.JPG||height="184" width="137"]]
33
34 **Sophia Pieschnik**
35 (% class="small" %)Biology (B.Sc.)
36 Neurocognitive Psychology (M.Sc.)
37
38
39 (% class="box successmessage" %)
40 (((
41 **Particular needs? Contact us! **The process of sharing data can be modified to fit the needs of researchers and large-scale projects. Contact us if you have such requests and we'll be happy to work with you to find a solution that suits us both.
42 )))
43
44 (% class="box floatinginfobox" %)
45 (((
46 **We strongly recommend to start preparing for data sharing as early as possible.** With a structured data repository and adequate notes on how the data was acquired, you greatly minimize the effort required to publish your data. The time it takes to share data on EBRAINS heavily depends on on the engagement from the researcher and how well the data and metadata is prepared before-hand. **[[Contact us for personalised guidance on how to prepare for sharing>>mailto:curation-support@ebrains.eu]]. **
47 )))
48
49
50
51
52
53 We promote sharing of experimental data, models, software, web services, metadata models,
54
55
56 ----
57
58 === Step by step - Experimental data ===
59
60
61 [[image:image-20230326054341-1.png]]
62
63 ==== ====
64
65 ==== **1. Provide some general information about your dataset** ====
66
67 The [[Curation request form>>https://nettskjema.no/a/277393#/]] collects preliminary information about your data, allowing us to assess whether the dataset fits within the scope of EBRAINS. The submission generates a curation ID allowing us to track the case.
68
69 The [[Ethics and Regulatory compliance form>>https://nettskjema.no/a/224765]] collects the necessary information needed for us to evaluate whether we can safely and legally share the data on the EBRAINS platforms.
70
71
72 ==== **2. Upload data ** ====
73
74 EBRAINS offers secure, long-term storage at [[CSCS Swiss National Supercomputing Centre>>url:https://www.cscs.ch/]], with currently no upper limit of storage capacity. The data must be consistently structured prior to upload. 
75
76 For smaller datasets with a reasonable amount of files, we recommend using the Collab-Bucket solution (drag-and-drop). A Collab Bucket must first be assigned to a dataset, which happens when a datasets is accepted for sharing.
77
78 For larger datasets or datasets with a large amount of files, we recommend using a programmatic approach. The [[python script>>https://github.com/eapapp/ebrains-data-storage/tree/main/data-proxy]] is interactive and does not require any additional programming.
79
80
81 If a data collection is already uploaded elsewhere, we may link to the already existing repository.
82
83
84 ==== **3. Submit metadata** ====
85
86 Easily submit openMINDS-compatible metadata via our [[metadata wizard>>https://ebrains-metadata-wizard.apps.hbp.eu/]]. This form covers all the required metadata for sharing data via EBRAINS. When you're ready to 'Submit', the metadata and all uploaded files will be sent to the Curation team.
87
88 For power-users interested in exploring the full span of the openMINDS framework, please check out the [[openMINDS GitHub>>https://github.com/HumanBrainProject/openMINDS]] to learn more about how to programmatically gather your metadata. A stable version of the openMINDS package can be found on [[PyPi>>https://pypi.org/project/openMINDS/]]. We accept openMINDS metadata as JSON-LD (share these with us via curation-support@ebrains.eu). Additional documentation of openMINDS metadata submodules and schemas can be found on [[the openMINDS GitHub Wiki>>https://humanbrainproject.github.io/openMINDS/]].
89
90
91 ==== **4. Write a Data Descriptor ** ====
92
93 The Data Descriptor is a document helping others interpret and reuse (and prevent misuse) of your data, and is critical to achieve a basic level of FAIR. The document will be uploaded in the repository of the data, shared as a PDF. 
94
95 [[The template >>https://drive.ebrains.eu/f/a2e07c95b1a54090bbbc/?dl=1]]safely guides you through the process of making one. Check out previous examples in the KG Search, e.g. the Data Descriptor for a dataset containing histology images of the rat brain stained for an anterograde tracer (see [[an example>>https://doi.org/10.25493/2MX9-3XF]]).
96
97
98 Journal publications sufficiently describing the shared data, such as made available through [[Nature Scientific Data>>http://www.nature.com/sdata/about]], [[Elsevier Data in Brief>>http://www.journals.elsevier.com/data-in-brief/]], [[BMC Data note>>https://bmcresnotes.biomedcentral.com/submission-guidelines/preparing-your-manuscript/data-note]] and more, can replace the EBRAINS Data Descriptor.
99
100
101 ==== **5. Preview and publish ** ====
102
103 A Curator will assemble a dataset in the EBRAINS Knowledge Graph that combines the data, metadata and data descriptor. Once ready, the data provider will receive a private URL for previewing the dataset prior to release. We need an official approval from the data custodian{{footnote}}The Data Custodian is responsible for the content and quality of the Data and metadata, and is the person to be contacted by EBRAINS CS in case of any misconduct related to the Data. It is the obligation of a Data Custodian to keep EBRAINS informed about changes in the contact information of the authors of the Datasets provided by them ([[EBRAINS Data Provision Protocol - version 1.1>>https://strapi-prod.sos-ch-dk-2.exo.io/EBRAINS_Data_Provision_Protocol_dfe0dcb104.pdf]]).{{/footnote}} to release the dataset. Once released, a [[DataCite DOI>>https://datacite.org/]] will be generated for the dataset. If the identical data collection has received a DOI elsewhere, we recommend re-using the already issued DOI.
104
105
106 ----
107
108 ==== **Sharing human data ** ====
109
110 We must ensure data shared on EBRAINS comply with [[GDPR >>https://gdpr-info.eu/]]and [[EU directives>>https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex%3A32010L0063]]. The information we need to assess this is collected via our [[Ethics and Regulatory Compliance Survey>>https://nettskjema.no/a/224765]].
111
112 (% class="box floatinginfobox" %)
113 (((
114 For **Human subject data**, the data must be //either//
115
116 - Post-mortem data
117
118 - Aggregated data
119
120 - Pseudonymized subject data with a legal basis for sharing (e.g. Informed Consent)
121
122 (% class="small" %)//If you have human data that do not classify as any of the above, please get in touch and we will clarify the available options. //
123 )))
124
125 Pseudonymized data is shared via the Human Data Gateway (HDG) due to GDPR regulations. The HDG adds an authentication layer to the data.
126
127 **Data users** must request access to the data (via their EBRAINS account) and will receive access provided they actively accept the [[EBRAINS Access Policy>>https://ebrains.eu/terms#access-policy]], the [[EBRAINS General Terms of Use>>https://ebrains.eu/terms#general-terms-of-use]], and the [[EBRAINS Data Use Agreement>>https://ebrains.eu/terms#data-use-agreement]]. The account holder also have to accept that information about their request and access to specific data under HDG is being tracked and stored.
128 \\**Data owners** must be aware that sharing under the HDG affects the legal responsibilities for the data. They must agree to joint control of the data (see the [[Data Provision Protocol v1>>url:https://strapi-prod.sos-ch-dk-2.exo.io/EBRAINS_Data_Provision_Protocol_dfe0dcb104.pdf]], section 1.4 - 1.5) and the Data Protection Officers of the responsible institutions must have accepted that the data can be shared under HDG.
129 \\The Human Data Gateway (HDG) was introduced in February 2021 and developed across multiple teams in the HBP. The initiative to create the service and the initial design originated from EBRAINS Curation in close collaboration with the Data compliance team and the HBP Data Governance Working Group. HDG is a response to the needs of multiple data providers who are bringing data of human origin to EBRAINS. HDG covers the sharing of a limited range of data of human origin, i.e., data without direct identifiers and with very few indirect identifiers (strongly pseudonymized, de-identified). It is an extension of the existing services and does not replace the future EBRAINS Service for sensitive data (planned for 2024) which is outside the domain of the current EBRAINS Data and Knowledge services.
130
131
132 ----
133
134 === Step by Step - Models ===
135
136 [place-holder-process-diagram]
137
138 ==== **1. model step 1 ** ====
139
140 Text
141
142
143 ==== **2. model step 2** ====
144
145 Text
146
147
148 ----
149
150 === Step by Step - Code ===
151
152 [place-holder-process-diagram]
153
154 ==== **1. code step 1 ** ====
155
156 Text
157
158
159 ==== **2. code step 2** ====
160
161 Text
162
163 ----
164
165 === When you've completed the curation process ===
166
167 Curated data, models and software are made available in the [[the EBRAINS Knowledge Graph>>https://kg.ebrains.eu/]]. This makes the data and metadata discoverable in the [[Knowledge Graph Search>>url:https://search.kg.ebrains.eu/]] and programmatically via the [[Knowledge Graph API>>url:https://docs.kg.ebrains.eu/8387ccd27a186dea3dd0b949dc528842/api_endpoints.html]]. The data, models and software are integrated in the EBRAINS Knowledge Graph by interoperable metadata schemas as defined in [[openMINDS>>url:https://github.com/HumanBrainProject/openMINDS/wiki]].
168
169 Data and models are linked to and discoverable via the species-specific [[EBRAINS Interactive Atlas Viewer>>url:https://ebrains.eu/services/atlases/brain-atlases]] by using interoperable metadata schemas as defined in [[SANDS>>url:https://github.com/HumanBrainProject/SANDS/wiki]].
170
171 ----
172
173 == **Information and resources for researchers looking to share data** ==
174
175 Below you can find some resources that can come in handy if you are looking to share data via EBRAINS, or in general.
176
177 ----
178
179 === **The benefits of sharing data ** ===
180
181 (% style="color:#000000" %)Sharing your data, models or code (research products) via EBRAINS makes it discoverable amongst other research products available in the (%%)[[(% style="color:#000000" %)EBRAINS Knowledge Graph>>https://kg.ebrains.eu/]](%%). This is made possible by the highly flexible metadata framework describing neuroscience data in detail.
182
183 (% style="color:#000000" %)EBRAINS is gradually implementing interconnected tools and analysis workflows developed in the Human Brain Project (HBP) to further enhance the output from adding your dataset to the database.
184
185
186 By sharing your data via EBRAINS, you gain access to the following benefits:
187
188 [[image:image-20230324170841-3.png]]
189
190
191
192 We support you to better follow the FAIR^^ ^^guiding principles for data management and stewardship{{footnote}}Wilkinson, M., Dumontier, M., Aalbersberg, I. et al. The FAIR Guiding Principles for scientific data management and stewardship. Sci Data 3, 160018 (2016). https://doi.org/10.1038/sdata.2016.18 {{/footnote}}.  Publishing data, models or code via EBRAINS will provide you with a citeable [[DataCite DOI>>https://www.doi.org/the-identifier/resources/handbook/]] for your research product.
193
194
195 ----
196
197 (% style="font-family:inherit" %) (% style="color:#1a202c; font-family:inherit; font-size:26px" %)**What can I share on EBRAINS? **
198
199 (% class="wikigeneratedid" id="H" %)
200 [[image:image-20230324170829-2.png]]
201
202
203 ----
204
205 === **At a glance: "Sharing experimental data on EBRAINS" ** ===
206
207
208 |(% style="width:439px" %)(((
209 [[[[image:image-20230324171114-2.png||height="354" width="250"]]>>https://drive.ebrains.eu/f/dfd374b9b43a458192e9/]]
210 )))|(% style="width:461px" %)(((
211 [[[[image:image-20230324171109-1.png||height="352" width="250"]]>>https://drive.ebrains.eu/f/c1ccb78be52e4bdba7cf/]]
212 )))|(% style="width:416px" %)[[[[image:image-20230330120354-1.png||height="352" width="250"]]>>https://drive.ebrains.eu/f/707147a883b94fae8e69/]]
213 |(% style="width:439px" %)//Collection of useful information for researchers looking to share experimental data on EBRAINS.//|(% style="width:461px" %)//The EBRAINS data descriptor: a general overview //|(% style="width:416px" %)//Introduction to data organization: A [[collection of guidelines>>https://drive.ebrains.eu/smart-link/25299f04-c4e5-4028-8f5f-3b8208f9a532/]] on how to organise files and folders to ensure consistency and reproducibility in the future. //
214
215 ----
216
217 === **Integrate your data in the EBRAINS atlas services** ===
218
219 EBRAINS supports viewers for a variety of data, and is continuously looking to improve the services for visualising data. For 2D histology image data that is registered to an EBRAINS supported brain atlas, the data and the overlying atlas plates can be uploaded to the LocaliZoom viewer. See for example the [[LocaliZoom links available for this dataset>>https://doi.org/10.25493/T686-7BX]] as an example.
220
221 To learn more about how to integrate your data to atlases, check out the [[Atlas services>>https://ebrains.eu/services/atlases#Integratedatatoanatlas]] on ebrains.eu.
222
223 ----
224
225 === **Common concerns - and answers ** ===
226
227 (((
228 ==== ====
229
230 (((
231 >The curation process is time consuming and difficult
232 )))
233 )))
234
235 (% class="wikigeneratedid" id="HHowcanIshareA0models3F" %)
236 Publishing your data naturally takes some time and effort but we will support you as much as possible. If communication is on a regular basis, we are able to finish basic curation - from the initial contact to dataset release - within two weeks.
237
238 >Sharing my data is not beneficial for me - only for others
239
240
241 When you publish your data via EBRAINS, we provide comprehensive data management support and safe long term storage - all free of charge. Additionally, your data can be cited, just like a scientific journal article. Sharing your data may even lead to new funding opportunities. Many funders specifically support projects that are part of the “Open Science” initiative.
242
243 >My data is too insignificant to share
244
245
246 There is no such thing as insignificant data. Data that is considered insignificant for a given topic, may have great significance for another. By making “insignificant” data publicly available, other researchers may find something interesting that was off-topic for your own purposes.
247
248 >My data can easily be misused if I share it with the world
249
250
251 Your data will be covered by a Creative Commons license of your choice. There are a variety of licenses available, enabling you to prevent use for specific purposes, e.g. commercial use.
252
253 >I don't think I'm allowed to share my data
254
255
256 Many institutions are still very careful about what can be shared and how, but the situation is constantly evolving. As a researcher providing data, you will be asked to fill out an ethics compliance survey which survey to ensure that data published through the EBRAINS platform has been collected according to EU regulations. We are working on solutions for sharing anonymised human data that complies with GDPR standards to protect the identity of research subjects.
257
258 >I can't share my data before my paper is published
259
260
261 If you do not want to share your data before publishing the results in an article, you can publish your dataset with an embargo status. This will make it possible to find information about the data without making the data itself available, and give you a citeable DOI.
262
263 >If I share my data before I publish the associated paper, I will lose my competitive edge
264
265
266 Publishing your data does not mean that others can use it however they want. Use of your data will require citation, and by choosing an appropriate Creative Commons licence you decide what others are allowed to do with it. If you still feel worried, you can publish your data under embargo, and in this way delay the date of data release, but still make it possible for others to find the information about the data.
267
268
269 ----
270
271 == Contact ==
272
273 [[curation-support@ebrains.eu>>mailto:curation-support@ebrains.eu]]
274
275
276 {{putFootnotes/}}