@@ -7,8 +7,8 @@ questions:
7
7
- " Who is this module for?"
8
8
- " How should I study it?"
9
9
objectives :
10
- - To think about reproducibility as an inherent part of research activities
11
- - To use lesson materials as soon as possible
10
+ - " Think about reproducibility as an inherent part of research activities"
11
+ - " Use lesson materials as soon as possible"
12
12
keypoints :
13
13
- " Efficient practices are the (more) reproducible ones"
14
14
@@ -19,8 +19,8 @@ keypoints:
19
19
The term "reproducibility" conjures a mental image of dedicated systems
20
20
conducting automated and repeatable computations. However, ** you** can
21
21
embrace reproducibility as a principle to apply to your day-to-day
22
- research activities. Neuroimaging is a heavily data- and software- driven
23
- field of science. As a result, by learning more tricks and techniques
22
+ research activities. Neuroimaging is a heavily data- and software-driven
23
+ field of science. As a result, by learning more tricks and techniques
24
24
for the tools that you already use daily, you will discover ways to
25
25
not only improve your efficiency but also to increase the reproducibility of
26
26
your research.
@@ -29,7 +29,7 @@ To some degree, reproducibility requires knowledge of **what**,
29
29
** when** , and ** how** any particular analysis was carried out.
30
30
Therefore the lessons in this module will focus on helping
31
31
answer those questions. Before addressing these specific questions,
32
- referenced external materials (tutorials, lessons, etc) will provide a
32
+ referenced external materials (tutorials, lessons, etc. ) will provide a
33
33
more generic and thorough presentation of the topics.
34
34
35
35
@@ -40,7 +40,6 @@ software for data analysis, writing custom code or editing documents.
40
40
41
41
> ## Prerequisites
42
42
>
43
- >
44
43
> Depending on your level of competence in any particular topic, you
45
44
> might like to go through additional materials that will be
46
45
> referenced in each particular lesson. Even if you feel that you are
@@ -51,13 +50,13 @@ software for data analysis, writing custom code or editing documents.
51
50
52
51
### How much time should this take?
53
52
54
- That primarily depends on your familiarity and experience with working
53
+ That primarily depends on your experience and familiarity with working
55
54
in command line/shell, using version control systems, managing
56
- software environments, having experience providing constructive
57
- feedback about defects you found in software you use, etc . All those
55
+ software environments, and providing constructive
56
+ feedback about defects you find in software you use. All those
58
57
topics seem independent but are also very much related, so it is likely
59
58
that you might have some familiarity with all of them, or that you know
60
- just one of them well. If you have no experience with any topic,
59
+ just one of them well. If you have no experience with any topic,
61
60
this may take you a long time: for instance, 5 to 7 full days. If you
62
61
are experienced, some of the information may be redundant and it may take
63
62
you only a few hours to go through this material in detail. In each
@@ -68,7 +67,7 @@ the lesson, assuming you have a basic understanding of the topic.
68
67
69
68
It is important to ** apply** the knowledge gained from the lessons to
70
69
your day-to-day activities as soon as possible! Start using shell
71
- and/or do it more efficiently by using shortcuts, scripting, making
70
+ and/or using it more efficiently by using shortcuts, scripting, making
72
71
those scripts robust, etc. Use version control systems for anything
73
72
you change (code, data, documents) and increase "traceable" collaboration
74
73
exchange, even if it’s just between you on computer 1 and you on
@@ -78,17 +77,17 @@ run into and don’t just leave them unresolved.
78
77
79
78
An efficient approach to learning the materials is to first skim
80
79
through all the materials, noting the key concepts and applying them
81
- right away. Then, after gaining experience and stumbling upon some
80
+ right away. Then, after gaining experience and stumbling on some
82
81
problems, it will be useful to review the relevant topic in greater
83
- detail while concentrating on the relevant aspects.
82
+ detail while concentrating on the most pertinent aspects.
84
83
85
84
** The least efficient approach would be to spend a week "learning
86
85
it" only to forget all of it by not using any of the learned tools
87
86
or recommended practices.**
88
87
89
88
### What are the lessons in this module?
90
89
91
- This module guides through three somewhat independent topics, which
90
+ This module will guide you through three somewhat independent topics, which
92
91
are at the heart of establishing and efficiently using common generic
93
92
resources: command line shell, version control systems (for code and
94
93
data), distribution package managers, and a few additional aspects such
0 commit comments