@@ -7,8 +7,8 @@ questions:
7
7
- " Who is this module for?"
8
8
- " How should I study it?"
9
9
objectives :
10
- - Think about reproducibility as an inherent part of research activities.
11
- - Apply lesson materials in your daily work as soon as possible.
10
+ - To think about reproducibility as an inherent part of research activities
11
+ - To use lesson materials as soon as possible
12
12
keypoints :
13
13
- " Efficient practices are the (more) reproducible ones"
14
14
@@ -18,50 +18,55 @@ keypoints:
18
18
19
19
The term "reproducibility" conjures a mental image of dedicated systems
20
20
conducting automated and repeatable computations. However, ** you** can
21
- embrace reproducibility in your day-to-day research activities.
22
- Neuroimaging is a heavily data- and software-driven field of science.
23
- As a result, by learning best practices for the tools you already use daily,
24
- you will discover ways to improve your efficiency and increase the
25
- reproducibility of your research.
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
24
+ for the tools that you already use daily, you will discover ways to
25
+ not only improve your efficiency but also to increase the reproducibility of
26
+ your research.
26
27
27
- Reproducibility requires us to know the ** what** , ** when** , and ** how**
28
- for any particular analysis we carry out. The lessons in this module will
29
- help us answer those questions. Before addressing these specific questions,
30
- consult the referenced external materials (tutorials, lessons, etc.) to get a
31
- more generic and thorough treatment of the topics.
28
+ To some degree, reproducibility requires knowledge of ** what** ,
29
+ ** when** , and ** how** any particular analysis was carried out.
30
+ Therefore the lessons in this module will focus on helping
31
+ answer those questions. Before addressing these specific questions,
32
+ referenced external materials (tutorials, lessons, etc) will provide a
33
+ more generic and thorough presentation of the topics.
32
34
33
35
34
36
### Who is this module for?
35
37
36
- This module is for any scientist, researcher, or student who is using
37
- software for data analysis, writing custom code, or editing documents.
38
+ The module is for any scientist, researcher, or a student who is using
39
+ software for data analysis, writing custom code or editing documents.
38
40
39
41
> ## Prerequisites
40
42
>
41
43
>
42
44
> Depending on your level of competence in any particular topic, you
43
- > may benefit from the external materials that referenced in each
44
- > particular lesson. Even if you feel that you're very proficient in all
45
- > of the topics, we hope you can still learn some new "tricks" or are
46
- > willing to recommend or contribute new materials to the lessons.
45
+ > might like to go through additional materials that will be
46
+ > referenced in each particular lesson. Even if you feel that you are
47
+ > very proficient in all of those topics, we hope that you can still
48
+ > learn some new "tricks" or are willing to recommend or contribute new
49
+ > materials to the lessons.
47
50
{: .prereq}
48
51
49
52
### How much time should this take?
50
53
51
- This depends on your familiarity with the command line/shell, version
52
- control systems, managing software environments, etc. All of these
53
- topics may seem independent but are in fact very much related; it's likely
54
+ That primarily depends on your familiarity and experience with working
55
+ 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
58
+ topics seem independent but are also very much related, so it is likely
54
59
that you might have some familiarity with all of them, or that you know
55
- just one of them well. If you have no experience with any topic,
56
- this may take you a long time: for instance, 5 to 7 full days. If you're
57
- already experienced, some of the information may be redundant and it may take
58
- you only a few hours to go through the material in detail. In each
60
+ just one of them well. If you have no experience with any topic,
61
+ this may take you a long time: for instance, 5 to 7 full days. If you
62
+ are experienced, some of the information may be redundant and it may take
63
+ you only a few hours to go through this material in detail. In each
59
64
lesson, we provide an estimate for the time it would take to learn
60
65
the lesson, assuming you have a basic understanding of the topic.
61
66
62
67
### How should the acquired knowledge be used?
63
68
64
- The most important lesson is to ** apply** the knowledge you gain to
69
+ It is important to ** apply** the knowledge gained from the lessons to
65
70
your day-to-day activities as soon as possible! Start using shell
66
71
and/or do it more efficiently by using shortcuts, scripting, making
67
72
those scripts robust, etc. Use version control systems for anything
@@ -73,24 +78,26 @@ run into and don’t just leave them unresolved.
73
78
74
79
An efficient approach to learning the materials is to first skim
75
80
through all the materials, noting the key concepts and applying them
76
- right away. Then, after gaining experience and stumbling on some
77
- problems, review the relevant topic in greater detail.
81
+ right away. Then, after gaining experience and stumbling upon some
82
+ problems, it will be useful to review the relevant topic in greater
83
+ detail while concentrating on the relevant aspects.
78
84
79
85
** The least efficient approach would be to spend a week "learning
80
86
it" only to forget all of it by not using any of the learned tools
81
87
or recommended practices.**
82
88
83
89
### What are the lessons in this module?
84
90
85
- This module introduces three somewhat independent topics at the heart of
86
- efficient and reproducible scientific computing: command line/shell,
87
- version control systems (for code and data), distribution package managers,
88
- and a few additional aspects such as bug reporting and licensing. It's
89
- unlikely that you've managed to completely avoid those tools so far,
90
- but it's possible that you've under-utilized their capabilities.
91
+ This module guides through three somewhat independent topics, which
92
+ are at the heart of establishing and efficiently using common generic
93
+ resources: command line shell, version control systems (for code and
94
+ data), distribution package managers, and a few additional aspects such
95
+ as bug reporting and licensing. It is very unlikely that you have
96
+ managed to completely avoid using those tools in past research activities,
97
+ but it is possible that you have under-utilized their capabilities.
91
98
Gaining additional skills in any of these topics can not only help
92
99
your day-to-day research activities become more efficient, but
93
- also lay the groundwork for establishing habits that will make your work
94
- more reproducible. Moreover, these topics are the foundation of future
100
+ also lay the foundation for establishing habits that will make your work
101
+ more reproducible. Moreover, these topics are the foundation of future
95
102
modules in the ReproNim curriculum.
96
103
0 commit comments