Package 'swirlify'

Description

Licensing your course is important if you want to share your course. For more information see https://github.com/swirldev/swirlify/wiki/Licensing-Your-Course. For more information about Creative Commons licenses see http://creativecommons.org/licenses/. For more information about software licenses see http://www.gnu.org/licenses/license-list.en.html.

Usage

add_license(author, year = format(Sys.Date(), "%Y"),
  open_source_content = TRUE, content_license = "CC BY 4.0",
  open_source_data = TRUE, data_license = "CC0",
  open_source_code = TRUE, code_license = "MIT")

Arguments

Examples

## Not run: 

# Add a license with simple open source options
add_license("Team swirl")

# Add a license so that derivative works are shared alike
add_license("Team swirl", content_license  = "CC BY-SA 4.0", code_license ="GPL3")

# Add a license that reserves all of the author's rights
add_license("Team Bizzaro swirl", open_source_content = FALSE,
                                  open_source_data = FALSE,
                                  open_source_code = FALSE)

## End(Not run)

Description

The MANIFEST file located in the course directory allows you to specify the order in which you'd like the lessons to be listed in swirl. If the MANIFEST file does not exist, lessons are listed alphabetically. Invisibly returns the path to the MANIFEST file.

Usage

add_to_manifest()

Value

MANIFEST file path, invisibly

Examples

## Not run: 
# Check what lesson you're working on, then add it to the MANIFEST
get_current_lesson()
add_to_manifest()

## End(Not run)

Description

Returns and prints the number of questions in the current lesson.

Usage

count_questions()

Value

Number of questions as an integer, invisibly

Examples

## Not run: 
count_questions()

## End(Not run)

Description

Jump right in to the current swirl lesson without needing to navigate swirl's menus. It's also possible to jump into the middle of a lesson.

Usage

demo_lesson(from = NULL, to = NULL)

Arguments

Examples

## Not run: 
# Demo current lesson from beginning through the end
demo_lesson()
# Demo current lesson from question 5 through the end
demo_lesson(5)
# Demo current lesson from question 8 through question 14
demo_lesson(8, 14)

## End(Not run)

Description

Get question numbers for any questions matching a regular expression

Usage

find_questions(regex)

Arguments

Value

A vector of integers representing question numbers.

Examples

## Not run: 
set_lesson()
find_questions("plot")
find_questions("which")

## End(Not run)

Description

Prints the current lesson and course that you are working on to the console

Usage

get_current_lesson()

Examples

## Not run: 
get_current_lesson()

## End(Not run)

Description

Decode Student's Submissions from Google Forms

Usage

google_form_decode(path = file.choose())

Arguments

Value

A data frame containing each student's results.

Examples

## Not run: 

# Choose the csv file yourself
google_form_decode()

# Explicity specify the path
google_form_decode("~/Desktop/My_Course.csv")


## End(Not run)

Description

Create an easily shareable HTML version of your swirl lesson. This function detects the lesson you are working on automatically via getOption('swirlify_lesson_file_path'), converts it to R Markdown (Rmd), then generates a stylized HTML document and opens it in your default browser. To prevent clutter, the Rmd files are not kept by default, but they can be kept by setting keep_rmd = TRUE.

Usage

lesson_to_html(dest_dir = NULL, open_html = FALSE, keep_rmd = FALSE,
  quiet = FALSE, install_course = TRUE)

Arguments

Details

The output is formatted to be a readable, standalone tutorial. This means that information contained in the swirl lesson such as answer tests and hints are excluded from the Rmd/HTML output.

Description

Useful for creating paths to a particular swirl course, as you might want to do in files like initLesson.R.

Usage

make_pathname(name)

Arguments

Value

A string vector where spaces are replaced with underscores.

Examples

make_pathname("Developing Data Products")
# "Developing_Data_Products"

make_pathname(c("R Programming", "Exploratory Data Analysis"))
# "R_Programming" "Exploratory_Data_Analysis"

Description

Creates a new lesson and possibly a new course in your working directory. If the name you provide for course_name is not a directory in your working directory, then a new course directory will be created. However if you've already started a course with the name you provide for course_name and that course is in your working directory, then a new lesson will be created inside of that course with the name you provide for lesson_name.

Usage

new_lesson(lesson_name, course_name, open_lesson = TRUE)

Arguments

Examples

## Not run: 
# Make sure you have your working directory set to where you want to
# create the course.
setwd(file.path("~", "Developer", "swirl_courses"))

# Make a new course with a new lesson
new_lesson("How to use pnorm", "Normal Distribution Functions in R")

# Make a new lesson in an existing course
new_lesson("How to use qnorm", "Normal Distribution Functions in R")

## End(Not run)

Description

"Pack" the course you are working on into a single compressed file that is easy to share. Invisibly returns the path to the .swc file.

Usage

pack_course(export_path = NULL)

Arguments

Value

A string, the path to the new .swc file, invisibly.

Examples

## Not run: 
# Set any lesson in the course you want to pack
set_lesson()

# Pack the course
pack_course()

# Export the .swc file to a directory that you specify
pack_course(file.path("~", "Desktop"))

## End(Not run)

Description

Choose a lesson to work on with swirlify by specifying the path to the lesson.yaml file or interactively choose a lesson file.

Usage

set_lesson(path_to_yaml = NULL, open_lesson = TRUE, silent = FALSE)

Arguments

Examples

## Not run: 
# Set the lesson interactively
set_lesson()

# You can also specify the path to the \code{yaml} file you wish to work on.
set_lesson(file.path("~", "R_Programming", "Functions", "lesson.yaml"))

## End(Not run)

Description

Find the directory where swirl courses are stored

Usage

swirl_courses_dir()

Value

A string with the path to where swirl is searching for courses.

Description

This function launches a user interface for writing swirl lessons.

Usage

swirlify(lesson_name = NULL, course_name = NULL)

Arguments

Examples

## Not run: 

# Set lesson beforehand
set_lesson()
swirlify()

# Start a new lesson in your current directory
swirlify("Lesson 1", "My Course")


## End(Not run)

Description

Run basic tests on all questions in the lessons listed in the MANIFEST. See add_to_manifest for information about the MANIFEST file.

Usage

test_course()

Examples

## Not run: 
# To test a course, set any lesson in that course as the current lesson
set_lesson()

# Run tests on every lesson in that course listed in the MANIFEST
test_course()

## End(Not run)

Description

Run basic tests on all questions in the current lesson.

Usage

test_lesson()

Examples

## Not run: 
# Set a lesson interactively
set_lesson()

# Run tests on that lesson
test_lesson()

## End(Not run)

Description

This function is deprecated. Please use demo_lesson instead.

Usage

testit(from = NULL, to = NULL)

Arguments

Description

Invisibly returns the path to the unpacked course directory.

Usage

unpack_course(file_path = file.choose(),
  export_path = dirname(file_path))

Arguments

Value

A string, the path to the unpacked course directory, invisibly.

Examples

## Not run: 
# Unpack a course and interactively choose a .swc file
unpack_course()

# Unpack a course where the .swc file is explicitly specified
unpack_course(file.path("~", "Desktop", "R_Programming.swc"))

# Unpack a course and specify where the .swc file is located and where the
# course should be exported.
unpack_course(file.path("~", "Desktop", "R_Programming.swc"),
 file.path("~", "Developer", "swirl"))

## End(Not run)

Description

Template for R command question

Usage

wq_command(output = "explain what the user must do here",
  correct_answer = "EXPR or VAL",
  answer_tests = "omnitest(correctExpr='EXPR', correctVal=VAL)",
  hint = "hint")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_command()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_command("Assign the value 5 to the variable x.",
 "x <- 5", "omnitest(correctExpr='x <- 5')", "Just type: x <- 5")

## End(Not run)

Description

Template for figure questions

Usage

wq_figure(output = "explain the figure here", figure = "sourcefile.R",
  figure_type = "new")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_figure()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_figure("Here we can see the curve of the normal distribution.",
 "normalplot.R", "new")

## End(Not run)

Description

Template for output without a question

Usage

wq_message(output = "put your text output here")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_message()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_message("Welcome to a course on the central limit theorem.")

## End(Not run)

Description

Template for multiple choice question

Usage

wq_multiple(output = "ask the multiple choice question here",
  answer_choices = c("ANS", "2", "3"), correct_answer = "ANS",
  answer_tests = "omnitest(correctVal= 'ANS')", hint = "hint")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_multiple()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_multiple("Which of the following is not a planet in our solar system?",
 c("Venus", "Saturn", "Pluto"), "Pluto", "omnitest(correctVal= 'Pluto')",
   "It's the smallest celestial body you can choose.")

## End(Not run)

Description

Template for exact numerical question

Usage

wq_numerical(output = "explain the question here",
  correct_answer = "42", answer_tests = "omnitest(correctVal=42)",
  hint = "hint")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_numerical()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_numerical("The golden ratio is closest to what integer?",
 "2", "omnitest(correctVal=2)", "It's greater than 1 and less than 3.")

## End(Not run)

Description

Template for R script question

Usage

wq_script(output = "explain what the user must do here",
  answer_tests = "custom_test_name()", hint = "hint",
  script = "script-name.R")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_script()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_script("Write a function that adds three numbers.",
 "add_three_test()", "Something like: add3 <- function(x, y, z){x+y+z}", 
 "add-three.R")

## End(Not run)

Description

Template for text question

Usage

wq_text(output = "explain the question here",
  correct_answer = "answer",
  answer_tests = "omnitest(correctVal='answer')", hint = "hint")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_text()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_text("Where is the Johns Hopkins Bloomberg School of Public Health located?",
 "Baltimore", "omnitest(correctVal='Baltimore')", "North of Washington, south of Philadelphia.")

## End(Not run)

Description

The url provided for video_link can be a link to any website.

Usage

wq_video(output = "Would you like to watch a short video about ___?",
  video_link = "http://address.of.video")

Arguments

Examples

## Not run: 
# While writing a new lesson by hand just use:
wq_video()

# If converting from another format to a swirl course you may want to sue the
# API:
wq_video("Now Roger will show you the basics on YouTube.",
 "https://youtu.be/dQw4w9WgXcQ")

## End(Not run)