Skip to content

Commit 43037d7

Browse files
committed
lesson clean-up; closes #47
1 parent e389447 commit 43037d7

File tree

3 files changed

+22
-21
lines changed

3 files changed

+22
-21
lines changed

content/index.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,6 @@ Image to get started:
99
17(3): e1008549. https://doi.org/10.1371/journal.pcbi.1008549)
1010

1111

12-
## Slides
13-
14-
We also have some slides:
15-
<https://github.com/coderefinery/modular-code-development>. But here we will
16-
try to do this as collaborative type-along where instructors try to solve a
17-
problem together and where learners guide the instructors through a
18-
collaborative document.
19-
20-
2112
:::{toctree}
2213
:maxdepth: 1
2314
:caption: The lesson

content/learning-outcomes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
- Understand how a command line interface to a code can improve usability and also
1616
make the code more versatile (to be combined with workflow management tools).
1717
- Connect modular code development to the remaining lessons (version control, testing,
18-
documentation, reusability).
18+
documentation, reproducibility).

content/lesson.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,23 @@ under the Creative Commons Attribution 4.0 International license (CC BY 4.0):
2020

2121
## Our initial goal
2222

23-
Our initial goal for this exercise is to plot a series of temperatures and precipitations
24-
for **January** and to compute and plot the **arithmetic mean**. We
25-
imagine that we assemble a working script from various internet research/ AI chat
26-
recommendations and arrive at:
27-
28-
```{literalinclude} code/initial-version.py
29-
:language: python
30-
```
23+
Our initial goal for this exercise is to plot a series of temperatures and
24+
precipitations for **January** and to compute and plot the **mean temperture**
25+
averaged over the month. We imagine that we assemble a working script from
26+
various internet research/ AI chat recommendations and arrive at:
27+
:::::{tabs}
28+
::::{group-tab} Python
29+
:::{literalinclude} code/initial-version.py
30+
:language: python
31+
:::
32+
::::
33+
34+
::::{group-tab} R
35+
Work in progress. You can
36+
[help us](https://github.com/coderefinery/modular-type-along/issues/40)
37+
by contributing or improving an R solution.
38+
::::
39+
:::::
3140

3241
This example is in Python but we will try to see "through" the code and
3342
focus on the bigger picture and hopefully manage to imagine other
@@ -38,10 +47,11 @@ elegant Python.
3847
## Further goals
3948

4049
- Once we get this working for **January**, our task changes to also
41-
plot the **Febrary** and the **March** in two additional
50+
plot the **February** and the **March** in two additional
4251
plots.
43-
- Then we wish to generalize the code so that a user can compute and plot this
44-
for **any month**, **without changing the code** (with a command line interface).
52+
- Later, we wish to generalize the code so that a user can compute and plot
53+
this for **any month**, **without changing the code** (with a command line
54+
interface).
4555

4656

4757
## How we plan to solve it

0 commit comments

Comments
 (0)