Skip to content

Commit 6d80977

Browse files
committed
Merge remote-tracking branch 'origin/main'
2 parents e1ac3ed + 08436e4 commit 6d80977

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

jose-submission/paper.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The workshop is available at [reproducibility.rocks](http://reproducibility.rock
3434

3535
# Statement of Need
3636

37-
Reproducibility is should be part of any data analysis work, but it's particularly important in scientific research.
37+
Reproducibility should be part of any data analysis work, but it's particularly important in scientific research.
3838
Achieving full reproducibility is challenging and requires, time, resources and specialised tools and skills [@whitaker2019].
3939
This workshops empowers researchers so they can maximize the reproducibility of their work by leveraging existing tools in the R ecosystem --such as RMarkdown, renv, and others--, version control and containers.
4040

@@ -46,16 +46,16 @@ The [notes for instructors](https://reproducibility.rocks/notes_for_instructors/
4646
The workshop is intended for researchers, data scientists, and anyone who uses R to generate documents and who wants to collaborate with other people (or themselves in the future).
4747
Basic prior experience with R is highly recommended.
4848

49-
The materials are organized in four 3-hour modules, ideally covered over a few weeks to give time to spaced practice [@benjamin2010] and homework assessment.
49+
The materials are organized in four 3-hour modules, ideally covered over a few weeks to allow time for spaced practice [@benjamin2010] and homework assessment.
5050
Each module has specific learning objectives (Table 1) and associated homework with the common goal of taking an existing non-reproducible research project and pushing it further in the reproducibly spectrum with each step.
5151

52+
| Day \# | Learning Objectives | Topics |
53+
|------------------|-------------------------------------|------------------|
54+
| [Day 1](https://reproducibility.rocks/materials/day1/): The workbench | 1\. Create an R project with a specific and useful structure; 2. Extend the use of RMarkdown files for reports and papers; 3. Use LaTeX templates to customize RMarkdown reports. | 1\. What is reproducibility anyway?; 2. A tidy project is a happy project 3. Reporting with R Markdown |
55+
| [Day 2](https://reproducibility.rocks/materials/day2/): Sharing and Contributing | 1\. Use git to track your work; Use git to collaborate with others; How to set up project documentation; Organizing a project. | 1\. here are the portable paths, 2. Getting the most of git; 3. Research compendia with rrtools |
56+
| [Day 3](https://reproducibility.rocks/materials/day3/): Managing Dependencies and data | 1\. Manage package dependencies inside a project; 2. How to pack and share data associated wth a project. | 1\. Managing R dependencies with renv; 2. Sharing data |
57+
| [Day 4](https://reproducibility.rocks/materials/day4/): Building Reproducible Computational Environments with Docker | 1\. Using docker to share a project. | 1\. Reproducible computational environment with Docker |
5258

53-
| Day \# | Learning Objectives | Topics |
54-
|-----------------|--------------------------------------|-----------------|
55-
| [Day 1](https://reproducibility.rocks/materials/day1/): The workbench | 1\. Create R project with an specific and useful structure; 2. Extend the use of RMarkdown files for reports and papers; 3. Use LaTeX templates to customize RMarkdown reports | 1\. What is reproducibility anyway?; 2. A tidy project is a happy project 3. Reporting with R Markdown |
56-
| [Day 2](https://reproducibility.rocks/materials/day2/): Sharing and Contributing | 1\. Using git to track your work; Using git to collaborate with others; How to set the documentation of your project; Organizing a project | 1\. here are the portable paths, 2. Getting the most of git; 3. Research compendia with rrtools |
57-
| [Day 3](https://reproducibility.rocks/materials/day3/): Managing Dependencies and data | 1\. Manage package dependencies inside a project; 2. How to pack and share data associated to a project | 1\. Managing R dependencies with renv; 2. Sharing data |
58-
| [Day 4](https://reproducibility.rocks/materials/day4/): Building Reproducible Computational Environments with Docker | 1\. Using docker to share a project | 1\. Reproducible computational environment with Docker |
5959
: Overview of the 4 modules and learning objectives.
6060

6161
## Instructional design
@@ -65,19 +65,20 @@ The material is taught using a combination of discussions, live coding, demonstr
6565
For each topic there is a multiple choice question to assess previous familiarity with the topic.
6666
Depending on the answers the instructor can decide if the topic needs to be covered in full or if it can be partially or entirely skipped.
6767

68-
| Method | Description |
69-
|-----------------|-------------------------------------------------------|
70-
| Discussions | Instructors present a topic and ask questions to the students to motivate a conversation. |
71-
| Live coding or demonstrations | Instructors write code or demonstrate how a tool works and invite students to follow along. |
72-
| Exercises | Students are invited to solve short exercises, either simply repeating what the instructor just showed, doing something similar, or working in groups to solve a particular problem. |
73-
| Continuous anonymous feedback | Students are asked at the end of each day to give feedback on 1. Something you like and we should keep and 2. Something you don't like that we should improve. |
68+
| Method | Description |
69+
|------------------|------------------------------------------------------|
70+
| Discussions | Instructors present a topic and ask questions to the students to motivate a conversation. |
71+
| Live coding or demonstrations | Instructors write code or demonstrate how a tool works and invite students to follow along. |
72+
| Exercises | Students are invited to solve short exercises, either simply repeating what the instructor just showed, doing something similar, or working in groups to solve a particular problem. |
73+
| Continuous anonymous feedback | Students are asked at the end of each day to give feedback on 1. Something you like and we should keep and 2. Something you don't like that we should improve. |
74+
7475
: Pedagogical methods used throughout the workshop
7576

76-
The [Notes for instructors](https://reproducibility.rocks/notes_for_instructors/) section includes secondary materials and templates that can help with preparing the workshop.
77+
The [Notes for instructors](https://reproducibility.rocks/notes_for_instructors/) section includes secondary materials and templates that can help to prepare for the workshop.
7778

7879
## Experience of use in teaching and learning situations
7980

80-
We delivered this workshop twice on-line.
81+
We delivered this workshop three times on-line.
8182
Participants were graduate and undergraduate students, experienced researchers, and private and government sector researchers.
8283
Each time two instructors where always present and shared the tasks of teaching, answering questions and troubleshooting technical issues.
8384
This also helps to keep the agenda on track and the general organization of the workshop.

0 commit comments

Comments
 (0)