📚 A toolbox for writing swirl courses
R
Latest commit 7a04c1b Jul 13, 2016 @seankross seankross committed on GitHub Merge pull request #20 from swirldev/dev
swirlify 0.5
Permalink
Failed to load latest commit information.
R removed utils remnants Jul 13, 2016
inst added google_form_decode test Jul 12, 2016
man
revdep major fixes to swirlify app Jul 13, 2016
tests
.Rbuildignore removed NEWS.md from .Rbuildignore Jul 13, 2016
.gitignore
.travis.yml major fixes to swirlify app Jul 13, 2016
DESCRIPTION added newline to end of DESCRIPTION Jul 13, 2016
LICENSE major fixes to swirlify app Jul 13, 2016
NAMESPACE removed utils remnants Jul 13, 2016
NEWS.md
README.md major fixes to swirlify app Jul 13, 2016
cran-comments.md
swirlify.Rproj

README.md

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:

  • Courses are directories that contain all of the files, folders, and lessons associated with the course you are developing. The name of the course directory is the name of the course. For example the name of the directory that contains Team swril's R Programming course is named R_Programming.
  • Lessons are directories that contain single units of instruction. The name of a lesson directory is the name of that lesson. Every lesson must at least contain a lesson.yaml file containing lesson content.
  • Questions are written inside of the lesson.yaml file in each lesson directory. Students are prompted with questions in sequential order.

Contact

If you have any questions about using swirlify don't hesitate to reach out to us: info@swirlstats.com