Build Status CRAN version

swirlify

swirlify is an R package that includes tools for writing and sharing swirl courses. For more information on swirl, visit our website or our GitHub repository.

Installation

CRAN Version

install.packages("swirlify")

Development Version

library(devtools)
install_github("swirldev/swirlify", ref = "dev")

Quick Start

We highly recommend using RStudio for authoring swirl content.

library(swirlify)

# Create a new lesson and a new course
new_lesson("My Lesson", "My Course")

# Add content to the lesson in a text editor

# When you are finished writing your lesson, add it to the course manifest
add_to_manifest()

# Convret your course into a `.swc` file so you can share it easily.
pack_course()

Documentation

For extensive documentation on swirlify and tips for writing swirl courses see the swirlify website.

Course structure

swirl courses have the following structrue:

Contact

If you have any questions about using swirlify don’t hesitate to reach out to us: [email protected]