Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
Welcome to the swirlify documentation. The swirlify package is designed to help users write and edit swirl courses.
What is a swirl course?
A swirl course is a directory that contains all of the files, folders, and lessons associated with the course you are developing. Lessons contain most of the content that students interact with, and the course sequentially organizes theses lessons. A course should conceptually encapsulate a single concept that you want to teach.
What is a lesson?
A lesson is a directory that contains all of the files required to execute one
unit of instruction inside of swirl. Every lesson must contain one
file which structures the text that the student will see inside the R console
while they are using swirl. The
lesson.yaml file contains a sequence of
questions and the primary utility of swirlify is to help course authors when
writing these questions.
What is the file structure of course?
Courses have the following general structure:
Course_Name ├─ Lesson_1 | └─ lesson.yaml ├─ Lesson_2 | └─ lesson.yaml └─ MANIFEST
MANIFEST file contains the order in which lessons will be displayed.
How do I get started writing swirl courses?
We highly recommend using RStudio for writing swirl courses and using swirlify. The swirlify package is intended to be used with an R console and a text editor simultaneously open. In this way, RStudio provides the perfect environment.
Click here to start learning how to create your own swirl courses.