Skip to content

Commit ec28a45

Browse files
authored
Merge pull request #31 from snastase/text-fix
Minor text adjustments and standardization
2 parents b133b54 + e3f35c4 commit ec28a45

File tree

7 files changed

+508
-511
lines changed

7 files changed

+508
-511
lines changed

_episodes/00-overview.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ questions:
77
- "Who is this module for?"
88
- "How should I study it?"
99
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"
1212
keypoints:
1313
- "Efficient practices are the (more) reproducible ones"
1414

@@ -19,8 +19,8 @@ keypoints:
1919
The term "reproducibility" conjures a mental image of dedicated systems
2020
conducting automated and repeatable computations. However, **you** can
2121
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
2424
for the tools that you already use daily, you will discover ways to
2525
not only improve your efficiency but also to increase the reproducibility of
2626
your research.
@@ -29,7 +29,7 @@ To some degree, reproducibility requires knowledge of **what**,
2929
**when**, and **how** any particular analysis was carried out.
3030
Therefore the lessons in this module will focus on helping
3131
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
3333
more generic and thorough presentation of the topics.
3434

3535

@@ -40,7 +40,6 @@ software for data analysis, writing custom code or editing documents.
4040

4141
> ## Prerequisites
4242
>
43-
>
4443
> Depending on your level of competence in any particular topic, you
4544
> might like to go through additional materials that will be
4645
> 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.
5150

5251
### How much time should this take?
5352

54-
That primarily depends on your familiarity and experience with working
53+
That primarily depends on your experience and familiarity with working
5554
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
5857
topics seem independent but are also very much related, so it is likely
5958
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,
6160
this may take you a long time: for instance, 5 to 7 full days. If you
6261
are experienced, some of the information may be redundant and it may take
6362
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.
6867

6968
It is important to **apply** the knowledge gained from the lessons to
7069
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
7271
those scripts robust, etc. Use version control systems for anything
7372
you change (code, data, documents) and increase "traceable" collaboration
7473
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.
7877

7978
An efficient approach to learning the materials is to first skim
8079
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
8281
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.
8483

8584
**The least efficient approach would be to spend a week "learning
8685
it" only to forget all of it by not using any of the learned tools
8786
or recommended practices.**
8887

8988
### What are the lessons in this module?
9089

91-
This module guides through three somewhat independent topics, which
90+
This module will guide you through three somewhat independent topics, which
9291
are at the heart of establishing and efficiently using common generic
9392
resources: command line shell, version control systems (for code and
9493
data), distribution package managers, and a few additional aspects such

0 commit comments

Comments
 (0)