Skip to content

Commit 83fbd3a

Browse files
Merge pull request #139 from UMCarpentries/pschloss-patch-1-1
Pat's edits to near final manuscript
2 parents 71dfef4 + bb0873d commit 83fbd3a

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

paper/paper.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Thus, we developed a new curriculum
8989
(https://umcarpentries.org/intro-curriculum-r/) that aims to teach novices how
9090
to implement reproducible research principles in their own data analysis.
9191
The curriculum integrates live coding lessons with individual-level and
92-
group-based practice exercises, and also serves as a succinct resource material
92+
group-based practice exercises, and also serves as a succinct resource
9393
that learners can reference both during and after the workshop.
9494
Moreover, it lowers the entry barrier for new instructors as they do not
9595
have to develop their own teaching materials or sift through extensive content.
@@ -101,7 +101,7 @@ interested in teaching workshops with similar learning objectives.
101101

102102
# Statement of Need
103103

104-
For the past five years, the University of Michigan instance of The Carpentries taught workshops
104+
For the past five years, the University of Michigan instance of The Carpentries has taught workshops
105105
using versions of curriculum originally created by The Carpentries organization.
106106
In that time, our instructors found several advantages and disadvantages to
107107
using the original Software Carpentry curriculum.
@@ -110,8 +110,7 @@ Python) could be paired with lessons on the Unix shell and version control,
110110
lessons had been refined by many contributors over the years and taught at
111111
workshops around the world, and the instructional design demonstrated good
112112
pedagogy for teaching novice data science practitioners.
113-
However, The Carpentries material was designed more as a reference material
114-
rather than a lesson plan, and thus there was too much content for the time
113+
However, The Carpentries materials have evolved from lesson plans to reference materials, and thus there was too much content for the time
115114
available during a two-day workshop.
116115
As a result, workshops taught with this material were inconsistent depending on
117116
who was teaching, and new instructors faced an overwhelming amount of work to
@@ -140,12 +139,11 @@ progress.
140139
We hosted the curriculum in a public GitHub repository
141140
(https://github.com/umcarpentries/intro-curriculum-r) to facilitate
142141
collaborative work and peer review using issues, branches, and pull requests.
143-
Under this model, a team member creates or edits content in a new branch to
142+
Under this model, a team member created or edited content in a new branch to
144143
resolve an issue,
145-
then creates a pull request and asks for review from another team member,
146-
who finally merges the changes into the default branch.
147-
GitHub pages automatically uses the default branch to build a website that would
148-
allow us to host the polished curriculum
144+
then created a pull request and asked for review from another team member,
145+
who finally merged the changes into the default branch.
146+
GitHub pages automatically uses the default branch to build a website that allows us to host the polished curriculum
149147
(https://umcarpentries.org/intro-curriculum-r/).
150148
Our collaborative model ensured that at least two pairs of eyes viewed any
151149
changes before they could be included in the curriculum.
@@ -219,10 +217,11 @@ The Unix shell, git, and GitHub are introduced using the files generated in the
219217
R for plotting lesson.
220218
The lesson content for subsequent modules is then intermittently committed and
221219
pushed to GitHub.
222-
The `Writing reports in R Markdown' lesson combines all of the skills learned
220+
The 'Writing reports in R Markdown' lesson combines all of the skills learned
223221
previously to produce a report that one could share with the United Nations.
224222
Next, learners put everything they have learned into practice by forming small
225-
groups and working on practice problems that cover the entire course content.
223+
groups and working on practice problems that cover the entire course content
224+
(["Integrating it all together: Paired exercise"](https://umcarpentries.org/intro-curriculum-r/05-r-markdown/index.html#integrating-it-all-together-paired-exercise)).
226225
The workshop completes with a short module recapping everything that the
227226
curriculum covered as well as offering suggestions on how learners can continue
228227
to get help and keep learning once the workshop ends.
@@ -255,19 +254,19 @@ indicate that an exercise was successfully completed.
255254

256255
We also incorporated a few additional key components into the curriculum:
257256

258-
1. Each lesson builds off of previous lessons, with the goal of creating a final report
257+
1. Each lesson built off of previous lessons, with the goal of creating a final report
259258
that can be shared with others.
260259
1. We structured the curriculum such that it could be taught through an
261260
in-person or virtual workshop. Virtual workshops are sometimes necessary, as during the COVID-19 pandemic, but are also useful to allow people from a variety of geographic locations to instruct and attend.
262-
1. We not only require learners to install all software before the workshop (as The
263-
Carpentries also requires), but also ask them to run an example script that tests
261+
1. We not only required learners to install all software before the workshop (as The
262+
Carpentries also requires), but also asked them to run an example script that tests
264263
whether everything is installed correctly.
265-
To attend the workshop, learners must send screenshots of the script output to the workshop lead in
266-
advance. This ensures that any installation issues can be
267-
addressed before the workshop begins.
264+
To attend the workshop, learners were required to send screenshots of the script output to the workshop lead in
265+
advance. We withheld the login details for the workshop until we received the screenshot. This ensured that any installation issues could be
266+
addressed before the workshop began.
268267
1. An extensive small group practice module towards the end of the workshop
269-
allows learners to more independently practice the skills they have learned.
270-
1. The workshop concludes with a recap of what was covered and resources
268+
allowed learners to more independently practice the skills they have learned.
269+
1. The workshop concluded with a recap of what was covered and resources
271270
available for learners to continue learning and getting help as their skills
272271
develop.
273272

@@ -325,7 +324,7 @@ completed the surveys.
325324

326325
# Funding
327326

328-
Salary support for PDS came from NIH grant R01CA215574.
327+
Salary support for PDS came from NIH grants R01CA215574 and U01AI124255.
329328
KLS received support from the NIH Training Program in Bioinformatics (T32
330329
GM070449).
331330
ZL received support from the National Science Foundation Graduate Research

0 commit comments

Comments
 (0)