-
Notifications
You must be signed in to change notification settings - Fork 10
/
do.html
310 lines (286 loc) · 13.9 KB
/
do.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<!DOCTYPE html>
<html lang="en">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-WJRL86VLXW"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-WJRL86VLXW');
</script>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Do - ReproNim</title>
<!-- CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
<link rel="stylesheet" href="https://code.ionicframework.com/ionicons/1.5.2/css/ionicons.min.css">
<link rel="stylesheet" href="css/style.css">
<!-- font -->
<link href='https://fonts.googleapis.com/css?family=Nova+Square' rel='stylesheet'>
<link rel="stylesheet" href="font/font.css">
</head>
<body>
<div id="wrapper">
<section class="section-1">
<header class="site-header">
<div class="container">
<div class="row">
<div class="col-sm-4 col-xs-8">
<h1 class="logo"><a href="index.html">ReproNim</a></h1>
</div>
<div class="col-sm-8 col-xs-4">
<nav class="navbar pull-right" role="navigation">
<!-- Brand and toggle get grouped for better mobile display -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="ion-navicon"></span>
</button>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li><a href="discover.html">Discover</a></li>
<li><a href="describe.html">Describe</a></li>
<li><a href="do.html">Do</a></li>
<li><a href="teach.html">Teach</a></li>
<li><a href="fellowship.html">Fellowship</a></li>
<li><a href="community.html">Community</a></li>
<li><a href="search.html">🔍</a></li>
</ul>
</div><!-- /.navbar-collapse -->
</nav>
</div>
</div> <!-- row -->
</div>
</header> <!-- site header -->
</section>
<section>
<div class="container">
<div class="row">
<div class="col-md-12">
<h1 class="main-page-header">Do</h1>
<h3 class="main-sub-header">What are you waiting for?<br> Just <strong>Do</strong> it—Embrace reproducibility from the get-go</h3>
</div>
</div><!-- row -->
<div class="row">
<div class="col-md-12">
<p>Our computational environments and infrastructure are growing more
powerful, more heterogeneous, and more complicated. Reproducibility
can be improved through practices and tools that 1) enable efficient
management of data and scripts while capturing the history and details
of changes and 2) facilitate executing analyses in a fashion that
supports inspection, comparison, validation, modification, and
re-execution.
<br>To become most effective, such solutions should consider all
stages of the scientific process, from planning the experiment and
collecting data to publishing the findings. We aim to assist the
neuroimaging community in improving reproducibility of their results
by <strong>Do</strong>ing</p>
<ul>
<li>data conversion with minimal manual effort while establishing
data provenance from the moment data are collected</li>
<li>collection and analysis of data provenance throughout different steps of
the scientific process</li>
<li>(re)execution of (previous) analyses in a scalable and flexible
manner by taking advantage of both existing infrastructure and new
technologies.</li>
</ul>
<p>
We strongly believe in the benefits of modular design,
collaboration, and reuse. That is why, instead of developing a
single monolithic platform to "solve all the problems", we are
reusing and contributing to existing projects as much as possible.
To that end, in the scope of this project, we actively maintain
relevant software
within <a href="http://neuro.debian.net">NeuroDebian</a> so that
ReproNim and other projects can benefit from this turnkey
platform. We also provided official Debian packaging for
<a href="http://singularity.lbl.gov">Singularity</a> "scientific
containerization" platform to make your research more flexible and
reproducible. With our ongoing software and platform development, we
aim to provide you with a collection of tools that are useful on
their own even if you choose not to use the full suite of products.
</p>
<p>
Currently we are focused on the following projects. You can help us
by trying and starting to use them, contributing, or by sharing your
ideas on how to improve them. We need your feedback (positive or
negative) to make our projects most beneficial
for <strong>your</strong> research.
</p>
</div>
</div>
</div>
</section>
<section class="section-3">
<div class="container">
<div class="row">
<div class="col-sm-4">
<h3><a href="http://github.com/repronim/reproin">ReproIn</a></h3>
<p>
Collect and prepare neuroimaging data in an efficient and automated
way to immediately benefit from the established community
standard <a href="http://bids.neuroimaging.io">Brain Imaging Data
Structure (BIDS)</a> and <a href="http://datalad.org">DataLad</a>, a
distributed data distribution and management system. To achieve that
we
</p>
<ul>
<li>formalize
a <a href="https://github.com/nipy/heudiconv/blob/master/heudiconv/heuristics/reproin.py">specification</a>
and <a href="https://github.com/ReproNim/reproin/blob/master/docs/walkthrough-1.md">procedures</a>
for MRI scanning to allow for flexible, automated, and
non-ambiguous conversion of all acquired MR
data from original DICOM files to BIDS dataset(s)</li>
<li>contribute to the development of
the <a href="http://github.com/nipy/heudiconv">Heuristic DICOM
Converter (HeuDiConv)</a> which provides us the base
implementation platform</li>
<li>integrate with "lab notebook" suites such
as <a href="https://github.com/ReproNim/brainverse">BrainVerse</a></li>
</ul>
<p>
Automatically converting all collected data to BIDS, while
retaining all original DICOMs as well a clear association between
raw and converted data, makes it possible to
</p>
<ul>
<li>
validate and assess the quality of data acquisition by using
the <a href="https://github.com/INCF/bids-validator">BIDS-validator</a>
and <a href="http://mriqc.readthedocs.io">MRIQC</a> to detect
possible problems with the design or acquisition in the earliest
stages of a project and avoid many common mistakes stemming from
manual data conversion and curation
<li>
automatically reconvert all collected data if relevant
defects get detected in the conversion backend utility,
if additional metadata stored in DICOMs is found to be necessary, or
in order to confirm the reproducibility of the data itself
</li>
<li>
make it possible to start data analysis immediately after
collection using any of the BIDS-aware applications
</li>
<li>
facilitate data sharing (private or public) and publication (data
descriptor papers) since all data is immediately almost completely
ready for sharing with a standardized file layout and annotation.
</li>
</ul>
<p>Visit <a href="http://reproin.repronim.org">reproin.repronim.org</a>
for more information.</p>
</div>
<div class="col-sm-4">
<h3><a href="https://github.com/myyoda">YODA</a> Principles</h3>
<p>YODA (<a href="https://github.com/myyoda">YODA’s organigram on data analysis</a>) outlines an approach for
using version control systems such as
<a href="http://git-scm.org">git</a>,
<a href="http://git-annex.branchable.com">git-annex</a>,
and <a href="http://datalad.org">DataLad</a> in a modular fashion to
cover the entire life-span of a research project with reliable,
non-ambiguous tracking and orchestration of all digital products of
a study (e.g., inputs, code, outputs). Modularization facilitates
the independent reuse of parts (e.g., the same data used across
multiple studies, versions of a software library used repeatedly) in
a manner that scales to dataset sizes found in cutting edge
high-resolution neuroimaging research.</p>
<p>
In the scope of the ReproIn project, having all data collected as
DataLad datasets makes it possible to
</p>
<ul>
<li>
start changing and enriching BIDS dataset with information not
available during scanning (condition onsets, dataset metadata,
etc.) while allowing for subsequent updates and merges with new
data coming from the scanner using standard Git mechanisms
</li>
<li>
distribute data for curation and processing across available
infrastructure while relying on git-annex to maintain information
about data availability, and Git providing clear information about
dataset version(s)
</li>
<li>
annotate sensitive data files with metadata to automatically
restrict their public sharing (e.g. original DICOMs, non-defaced anatomicals).
</li>
</ul>
<p>We also extend and contribute new functionality
to <a href="http://datalad.org">DataLad</a> to facilitate
VCS-enabled provenance tracing of execution and results:
<ul>
<li>
<strong><a href="http://docs.datalad.org/en/latest/cmdline.html#reproducible-execution">run/rerun</a></strong>
(see <a href="http://docs.datalad.org/en/latest/usecases/simple_provenance_tracking.html">DataLad
documentation on provenance tracking</a>)
</li>
<li>
<strong><a href="http://docs.datalad.org/en/latest/generated/man/datalad-addurls.html">addurls</a></strong>
to produce DataLad dataset(s) from a set of structured data as
in the <a href="https://github.com/ReproNim/simple_workflow">Simple
Workflow</a> papers.</li>
</ul>
</li>
</ul>
<p>
You can adhere to YODA principles by making a better use of VCS in
your research projects. Visit and contribute to
our <a href="http://www.repronim.org/module-reproducible-basics/02-vcs/">training
materials</a> and <a href="https://github.com/myyoda/template">YODA
template</a> repository.</p>
</div>
<div class="col-sm-4">
<h3><a href="https://github.com/ReproNim/ReproMan">ReproMan</a></h3>
<p>Neuroimaging Computation Environments Manager
(<a href="http://reproman.repronim.org">ReproMan</a>) is being
developed to help researchers track and manage computation resources
that they have available and to use them in a reproducible and
scalable way. We aim for ReproMan to</p>
<ul>
<li>collect information about used resources—such as software packages
(Debian, Conda, pip), VCS repositories (Git, SVN), containers
(Docker, Singularity)—possibly enriching already
collected provenance information (e.g., obtained
from <a href="http://www.repronim.org/describe.html">BrainVerse</a>,
<a href="http://reprozip.org">ReproZip</a>, or workflow
engines). We emphasize collecting an exhaustive amount of
information so it could be sufficient to later automatically
re-instantiate necessary components given just a
specification.</li>
<li>analyze collected information to answer questions like
<ul>
<li>"Am I using the same software as in the original analysis?"
<li>"What has changed?"
<li>"Does a given environment satisfy the necessary requirements?"
</ul>
</li>
<li>(when feasible) adjust any given computational environment to
satisfy the specified requirements, or just repopulate a new
(Docker, Singularity, etc.) container which would.</li>
<li>provide a uniform interface to a variety of computational
environments (containers, cloud, etc.) for interactive
sessions and scheduling of computational tasks while allowing
for tracing of computational resources used by the
computation.</li>
</ul>
<p>Visit <a href="http://reproin.repronim.org">reproin.repronim.org</a> for more information.</p>
</div>
</div> <!-- row -->
</div>
</section> <!-- section-2 -->
<footer class="site-footer">
<div>
<ul class="list-inline quicklinks">
<li>Copyright © ReproNim 2016-2024</div>
<li>Support: <a href="https://projectreporter.nih.gov/project_info_description.cfm?aid=8999833">NIH-NIBIB P41 EB019936</a></li>
<li>Site theme: themewagon.com</li>
</ul>
</div>
</footer>
</div> <!-- wrapper -->
<!-- js -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
</body>
</html>