7 min read

Teach a person to Swirl

Matt Dray (@mattdray)

A machine makes lots of cookie swirls, a metaphor for how many Swirl courses you’ll make with Swirlify (via Giphy)

A machine makes lots of cookie swirls, a metaphor for how many Swirl courses you’ll make with Swirlify (via Giphy)

tl;dr

Teach people to teach other people. That seems an efficient way to maximise impact.

  • {swirl} lets people learn R from within R
  • {swirlify} is a package to help write Swirl courses
  • This post explains how to start a Swirl course with Swirlify
  • For example, I’ve begun Tidyswirl for teaching tidyverse packages

Swirl

Swirl is a platform that:

teaches you R programming and data science interactively, at your own pace, and right in the R console!

Learning with Swirl is active and your understanding is checked throughout. You can move at your own pace and download additional courses to learn about new things. And it’s free.

Install and load Swirl to begin and then follow the instructions printed in the console.

install.packages("swirl")
library(swirl)
swirl()
Swirl being loaded and run from the console

Swirl being loaded and run from the console

You’ll be given a list of courses to install, but you can also download them from elsewhere. This post is about how you can quickly create and distribute such a course.

Swirlify

Sean Kross and Nick Carchedi have created the {swirlify} package to make course creation easy. This post covers a simple workflow to get you started, but full Swirlify guidance is available.

Get up and running

Create a new lesson folder (‘Lesson 1’), which will be autopopulated with template files for your lesson. This will also create a new parent course folder (‘New Course’) if it doesn’t already exist.

library(swirl)  # install.packages("swirl")
library(swirlify)  # install.packages("swirlify")
new_lesson(course_name = "New Course", lesson_name = "Lesson 1")

The following folder structure is generated:

Working directory/
└── New_Course/
    └── Lesson_1/
        ├── customTests.R
        ├── dependson.txt
        ├── initLesson.R
        └── lesson.yaml

The lesson.yaml file is the most important one. It’s basically a text file where each question is stored as text. Users advance through each of these questions when they run the lesson.

The lesson file can be edited directly, but we’ll focus on the built-in Swirlify Shiny app for simplicity:

swirlify(course_name = "New Course", lesson_name = "Lesson 1")

The app will open the named lesson from the named course in a new browser window. On the left is where you create new questions. On the right you can see the lesson.yaml file itself.

The Swirlify Shiny app provides a GUI for writing lessons

The Swirlify Shiny app provides a GUI for writing lessons

Note the ‘Help’ tab, which tells you about the types of questions you can make, or you can see the Swirlify guidance). Basically the question types are:

  • ‘message’ for informational text (not for questions per se)
  • ‘command’ for answers that require simple R expressions as answers
  • ‘numerical’ and ‘text’ for answers that are numbers or words
  • ‘multiple choice’ for multiple choice (as in the figure above)
  • ‘figure’ and ‘video’ for referring to media (‘video’ can take a user to any URL)
  • ‘script’ for longer R expressions that requires you to write custom answer tests (this is more advanced)

To build a question:

  1. Choose a question type from the dropdown menu on the left
  2. Fill in the text boxes (note that the answer tests box is completed for you if you type into the correct answer box and then press the ‘Make Answer Test from Correct Answer’ button)
  3. Click the ‘Add Question’ button see the question added to the file (on the right hand side)
  4. Click ‘Save Lesson’
  5. Run test_lesson() to look for errors
  6. Click ‘Demo Lesson’ to try it out
Create a question, generate the answer test and add it to the lesson

Create a question, generate the answer test and add it to the lesson

Continue adding questions until the lesson is complete. Then:

  1. Run add_to_manifest() to add the lesson to the MANIFEST file (it’ll be created in the course directory if it doesn’t already exist). Lessons in here are recognised as part of the course in the declared order.
  2. Use new_lesson() to create a new one, remembering to change the lesson_name argument and also add this lesson to the MANIFEST as well.

You should end up with a folder structure like this:

Working directory/
└── New_Course/
    ├── Lesson_1/
    |   ├── customTests.R
    |   ├── dependson.txt
    |   ├── initLesson.R
    |   └── lesson.yaml
    ├─ Lesson_2/
    |   ├── customTests.R
    |   ├── dependson.txt
    |   ├── initLesson.R
    |   └── lesson.yaml
    └─ MANIFEST

When your lessons are completed, you’re ready to share your course. Jump now to the share your course section or first learn some extra knowledge about lesson file structure, correct answers or lesson startup below.

Extra knowledge

Clearly the process of course building is more nuanced than outlined above, but you can learn more from the documentation on the Swirlify site and reference manual. In particular, See the course structure and writing lessons pages of the Swirlify guidance.

I’ll touch on three things here: lesson file structure, correct answers and lesson startup.

Lesson file structure

The lesson file is written in YAML, which is basically a special form of plain text. Questions appear as separate blocks of text that start with a hyphen and a question type (class) declaration, followed by further arguments on new indented lines.

The first block is always Class: meta and provides basic information about the file, like your name and the lesson name. Another simple one is Class: text to which you supply only one more argument, the Output, which is text to display to the user.

- Class: text
  Output: Did I mention chocolate hobnobs are great?

There are actually three ways to add questions:

  1. In the Shiny app, as outlined earlier in this post.
  2. By using the wq_*() family of functions to add questions to the active lesson – wq_message(output = "Text here") adds informative text, for example.
  3. By writing directly into the YAML file.

There’s more on questions classes and how to write them in the Swirlify guidance.

Correct answers

How are answers enoded and checked in lesson.yaml? Consider the YAML for this question:

- Class: cmd_question
  Output: Use mean() to calculate the mean of the numbers 1 to 5.
  CorrectAnswer: mean(1:5)
  AnswerTests: omnitest(correctExpr='mean(1:5'))
  Hint: Use the form x:y to provide numbers to mean().

So CorrectAnswer is where you provide the correct answer (!). This line will be run if the user chooses to skip() the question. AnswerTests is, however, what the user’s input will actually be evaluated against. It uses the omnitest function to compare the correct expression (correctExpr) to the user’s answer.

But often there’s more than one way to answer. The any_of_exprs() function should be used in this case.

- Class: cmd_question
  Output: Use mean() to calculate the mean of the numbers 1 to 5.
  CorrectAnswer: mean(1:5)
  AnswerTests: any_of_exprs('mean(1:5)', 'mean(c(1, 2, 3, 4, 5))')
  Hint: You can use the form x:y or c(x, y) to provide numbers to mean().

There’s more on answer testing in the Swirlify guidance, including how to write custom answer tests.

Lesson startup

Anything in the initLesson.R file will be run when the lesson is loaded. You can create objects and refer to them in your questions. For example, you could add a data frame:

biscuits <- data.frame(
  name = c("Chocolate hobnob", "Digestive", "Custard cream"),
  rating = c(10, 5, 7) 
)

You could then ask in lesson.yaml something like:

- Class: cmd_question
  Output: Use index notation to subset for biscuits rated over 5.
  CorrectAnswer: biscuits[biscuits$rating > 5, ]
  AnswerTests: omnitest(correctExpr='biscuits[, biscuits$rating > 5]')
  Hint: Remember the indexing format dataframe[rows, columns].

The dataframe was loaded on startup, so the user can interact with it to answer the question.

You can also add datasets to the lesson folder and read them into the user’s environment via the initLesson.R file. See the Swirlify guidance on including data for more information.

Share your course

Congratulations. You’re ready to share your course.

There are several ways to do this. It’s easiest for learners to use Swirl’s swirl::install_course_*() functions to install courses from:

  • a GitHub repo
  • a zip file stored on DropBox, Google Drive, or some URL
  • a course folder – zipped or not – downloaded locally on their machine

You can also compress your course to a single .swc file with compress_course() and raise a pull request for it to be hosted on the Swirl Course Network. It can be downloaded from there with install_course().

Swirl is strengthened by having a greater number and range of courses.

Tidyswirl

A mockup hex sticker for Tidyswirl that look suspiciously simimlar to the tidyverse sticker

A mockup hex sticker for Tidyswirl that look suspiciously simimlar to the tidyverse sticker

To minimise hypocrisy, I’ve started a Swirl course called Tidyswirl. The goal is to introduce each core package of the tidyverse. It currently has draft lessons for {tidyr} and {tibble}.

Tidyswirl is currently in development on GitHub. To install and try it out in Swirl:

install_course_github("matt-dray", "tidyswirl")

Please feel free to contribute new lessons or raise issues.

Plea

The R community is large and friendly. Swirl helps people learn. It would be great to see more courses being made. Consider making one to teach your colleagues about common R tasks in yoru department, for example.