generated from carpentries/workbench-template-md
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Amanda Miotto
committed
Apr 3, 2024
1 parent
06d3d7d
commit 0119175
Showing
2 changed files
with
162 additions
and
147 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,158 +1,20 @@ | ||
--- | ||
title: "Information for instructors" | ||
title: "Introduction to this Reproducible Research workshop" | ||
teaching: 10 | ||
exercises: 0 | ||
--- | ||
|
||
# What are we going to learn today? | ||
|
||
# Introduction and information for Instructors | ||
|
||
::::::::::::::::::::::::::::::::::::: objectives | ||
|
||
- Learn what is reproducibility and why does it matter? | ||
- Gain a number of skills and resources to help us build reproducibility in our everyday workflows | ||
- Understand the relationship between Reproducible Research and other areas such as Culture, Risk and Business Continuity | ||
|
||
:::::::::::::::::::::::::::::::::::::::::::::::: | ||
|
||
## How we will use the callout components for this course | ||
|
||
|
||
::::::::::::::::::: prereq | ||
|
||
### Find out More! | ||
|
||
This is the component guide for the workbench. For details on how to create | ||
components from [fenced divs][fenced-divs], read the [Callout Blocks section of | ||
"Episode Structure"](episodes.Rmd#callout-blocks). | ||
|
||
:::::::::::::::::::::::::: | ||
|
||
## Required Sections | ||
|
||
The workbench requires `objectives` and `questions` at the beginning and | ||
`keypoints` at the end of each episode. | ||
|
||
|
||
|
||
::::::::::::::::: questions | ||
|
||
### QUESTIONS (`questions`) | ||
|
||
QUESTIONS callouts are created with the `questions` tag and offer questions for | ||
the learner before they start the episode. | ||
|
||
::::::::::::::::::::::::::: | ||
|
||
|
||
::::::::::::::::: keypoints | ||
|
||
### KEYPOINTS (`keypoints`) | ||
|
||
KEYPOINTS callouts are created with the `keypoints` tag and offer key takeaways | ||
from the episode to summarise what the learners should have learned. | ||
|
||
::::::::::::::::::::::::::: | ||
|
||
|
||
|
||
## Instructor Notes | ||
|
||
Special sections that only appear on the instructor view (use the button at the | ||
top right of the page to toggle). | ||
|
||
::::::::::::::::::: instructor | ||
|
||
### INSTRUCTOR NOTE (`instructor`) | ||
|
||
Instructor notes are created with the `instructor` tag | ||
|
||
:::::::::::::::::::::::::::::: | ||
|
||
|
||
|
||
## Callout Blocks | ||
|
||
Sections to pause the narrative flow of an episode for learners to reflect. | ||
|
||
::::::::::::::::: callout | ||
|
||
### CALLOUT (`callout`) | ||
|
||
CALLOUT callouts are created with the `callout` tag and are an aside or comment. | ||
|
||
::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: prereq | ||
|
||
### PREREQUISITES (`prereq`) | ||
|
||
PREREQUISITES callouts are created with the `prereq` tag and indicate things a | ||
learner needs before starting the episodes (e.g. data from a previous episode or | ||
and understanding of a particular concept). | ||
|
||
:::::::::::::::::::::::: | ||
|
||
::::::::::::::::: checklist | ||
|
||
### CHECKLIST (`checklist`) | ||
|
||
CHECKLIST callouts are created with the `checklist` tag and are a way to more | ||
strongly emphasise particular steps. | ||
|
||
::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::::::::::::::::::: challenge | ||
|
||
### CHALLENGE (`challenge`) | ||
|
||
CHALLENGE callouts are created with the `challenge` tag and represent formative | ||
assessment opportunities for the learners to practice their skills. | ||
|
||
::::::::::::::::: hint | ||
|
||
### HINT (`hint`) | ||
|
||
HINT accordions are created with the `hint` tag and nested within | ||
`challenge` callouts. These offer more context for the challenge that can help | ||
the learner find the solution. | ||
|
||
:::::::::::::::::::::: | ||
|
||
::::::::::::::::: solution | ||
|
||
### SOLUTION (`solution`) | ||
|
||
SOLUTION accordions are created with the `solution` tag and nested within | ||
`challenge` callouts. These provide the learners with the solution to the | ||
challenge so they can confirm their answers. | ||
|
||
:::::::::::::::::::::::::: | ||
|
||
|
||
::::::::::::::::::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: discussion | ||
|
||
### DISCUSSION (`discussion`) | ||
|
||
DISCUSSION callouts are created with the `discussion` tag and represent an | ||
open-ended formative assessment in which the learners are expected to discuss | ||
a particular topic with other learners. | ||
|
||
:::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: testimonial | ||
|
||
### TESTIMONIAL (`testimonial`) | ||
|
||
TESTIMONIAL callouts are created with the `testimonial` tag and are quotations | ||
from previous learners or instructors. | ||
|
||
::::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: spoiler | ||
|
||
### SPOILER (`spoiler`) | ||
|
||
SPOILER callouts are created with the `spoiler` tag and | ||
are a way to provide additional details/content | ||
that can be expanded and collapsed on demand. | ||
|
||
::::::::::::::::::::::::: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,158 @@ | ||
--- | ||
title: 'Instructor Notes' | ||
title: "Information for instructors" | ||
teaching: 10 | ||
exercises: 0 | ||
--- | ||
|
||
This is a placeholder file. Please add content here. | ||
|
||
# Introduction and information for Instructors | ||
|
||
|
||
|
||
|
||
## How we will use the callout components for this course | ||
|
||
|
||
::::::::::::::::::: prereq | ||
|
||
### Find out More! | ||
|
||
This is the component guide for the workbench. For details on how to create | ||
components from [fenced divs][fenced-divs], read the [Callout Blocks section of | ||
"Episode Structure"](episodes.Rmd#callout-blocks). | ||
|
||
:::::::::::::::::::::::::: | ||
|
||
## Required Sections | ||
|
||
The workbench requires `objectives` and `questions` at the beginning and | ||
`keypoints` at the end of each episode. | ||
|
||
|
||
|
||
::::::::::::::::: questions | ||
|
||
### QUESTIONS (`questions`) | ||
|
||
QUESTIONS callouts are created with the `questions` tag and offer questions for | ||
the learner before they start the episode. | ||
|
||
::::::::::::::::::::::::::: | ||
|
||
|
||
::::::::::::::::: keypoints | ||
|
||
### KEYPOINTS (`keypoints`) | ||
|
||
KEYPOINTS callouts are created with the `keypoints` tag and offer key takeaways | ||
from the episode to summarise what the learners should have learned. | ||
|
||
::::::::::::::::::::::::::: | ||
|
||
|
||
|
||
## Instructor Notes | ||
|
||
Special sections that only appear on the instructor view (use the button at the | ||
top right of the page to toggle). | ||
|
||
::::::::::::::::::: instructor | ||
|
||
### INSTRUCTOR NOTE (`instructor`) | ||
|
||
Instructor notes are created with the `instructor` tag | ||
|
||
:::::::::::::::::::::::::::::: | ||
|
||
|
||
|
||
## Callout Blocks | ||
|
||
Sections to pause the narrative flow of an episode for learners to reflect. | ||
|
||
::::::::::::::::: callout | ||
|
||
### CALLOUT (`callout`) | ||
|
||
CALLOUT callouts are created with the `callout` tag and are an aside or comment. | ||
|
||
::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: prereq | ||
|
||
### PREREQUISITES (`prereq`) | ||
|
||
PREREQUISITES callouts are created with the `prereq` tag and indicate things a | ||
learner needs before starting the episodes (e.g. data from a previous episode or | ||
and understanding of a particular concept). | ||
|
||
:::::::::::::::::::::::: | ||
|
||
::::::::::::::::: checklist | ||
|
||
### CHECKLIST (`checklist`) | ||
|
||
CHECKLIST callouts are created with the `checklist` tag and are a way to more | ||
strongly emphasise particular steps. | ||
|
||
::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::::::::::::::::::: challenge | ||
|
||
### CHALLENGE (`challenge`) | ||
|
||
CHALLENGE callouts are created with the `challenge` tag and represent formative | ||
assessment opportunities for the learners to practice their skills. | ||
|
||
::::::::::::::::: hint | ||
|
||
### HINT (`hint`) | ||
|
||
HINT accordions are created with the `hint` tag and nested within | ||
`challenge` callouts. These offer more context for the challenge that can help | ||
the learner find the solution. | ||
|
||
:::::::::::::::::::::: | ||
|
||
::::::::::::::::: solution | ||
|
||
### SOLUTION (`solution`) | ||
|
||
SOLUTION accordions are created with the `solution` tag and nested within | ||
`challenge` callouts. These provide the learners with the solution to the | ||
challenge so they can confirm their answers. | ||
|
||
:::::::::::::::::::::::::: | ||
|
||
|
||
::::::::::::::::::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: discussion | ||
|
||
### DISCUSSION (`discussion`) | ||
|
||
DISCUSSION callouts are created with the `discussion` tag and represent an | ||
open-ended formative assessment in which the learners are expected to discuss | ||
a particular topic with other learners. | ||
|
||
:::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: testimonial | ||
|
||
### TESTIMONIAL (`testimonial`) | ||
|
||
TESTIMONIAL callouts are created with the `testimonial` tag and are quotations | ||
from previous learners or instructors. | ||
|
||
::::::::::::::::::::::::::::: | ||
|
||
::::::::::::::::: spoiler | ||
|
||
### SPOILER (`spoiler`) | ||
|
||
SPOILER callouts are created with the `spoiler` tag and | ||
are a way to provide additional details/content | ||
that can be expanded and collapsed on demand. | ||
|
||
::::::::::::::::::::::::: | ||
|