Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding lesson objectives and descriptions for Instructor training checkout #16

Open
wants to merge 5 commits into
base: gh-pages
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion 01-automation-instructor-notes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# 01-automation Instructor notes
# Instructor notes for "automation"

## Learning Objectives

- Explain the motivation for automation
- Present the underlying data and manuscript
- Participants understand the basics of the R code presented

1. Show the starting point (see content of `example-manuscript` folder):
- one file per country in the `data-raw` folder
Expand Down
8 changes: 7 additions & 1 deletion 02-functions-instructor-notes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# 02-functions Instructor notes
# Instructor notes for "Functions"

## Learning Objectives
- Explaining functions in R
- Write a simple function
- Refactor a simple function
- Basic understanding of scoping

### How to write functions in R?

Expand Down
4 changes: 4 additions & 0 deletions 03-functions-for-data-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Instructor notes for "Functions for data"

##Lesson Objectives
- Function to read data into R code
- Function to write data to R code

Starting with this part of the lesson, the instructor should explain what the
chunks of code do.

Expand Down
3 changes: 3 additions & 0 deletions 04-functions-for-figures-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## Instructor notes for "Functions for figures"

##Lesson Objectives
- Using functions to create figures

Again, the instructor should show what the chunks of code do before letting
participants convert them into functions.

Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ This lesson teaches some tips and tricks that will make life easier with `RMarkd

- Explain what the handout file contains

## Submodules

[Automation] (01-automation-instructor-notes.md)
This lesson outlines the manuscript and begins the process. Beginning with the data, the lesson explores the '''manuscript-inline.Rmd'''.

[Writing Functions in R] (02-functions-instructor-notes.md)
Basic lesson in writing functions using R

[Functions for Data] (03-functions-for-data-notes.md)
Writing functions to automate data gathering and sharing them.

[Function for Figures] (04-functions-for-figures-notes.md)
Writing functions to provide figures for papers.
## People and credits

This lesson was first created at the [1. Reproducible Science Curriculum Hackathon]. The corresponding author is **François Michonneau** ([@fmichonneau]). See the commit log for other contributors.
Expand Down