-
Notifications
You must be signed in to change notification settings - Fork 47
Home
Welcome to the swirlify documentation. The swirlify package is designed to help users write and edit swirl courses.
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.
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 lesson.yaml
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.
Courses have the following general structure:
Course_Name
├─ Lesson_1
| └─ lesson.yaml
├─ Lesson_2
| └─ lesson.yaml
└─ MANIFEST
The MANIFEST file contains the order in which lessons will be displayed.
This documentation is accurate for swirlify version 0.4.1. If you believe changes should be made to this document please open a new issue. The code contained in this documentation is MIT licensed. The content of this documentation is licensed CC BY 4.0.
- Welcome!
- Creating a New Course
- Creating a New Lesson in an Existing Course
- Resuming Work on a Lesson in an Existing Course
- Checking Which Lesson You're Working On