use_tutorial: Create a learnr tutorial

Description Usage Arguments See Also Examples

View source: R/tutorial.R

Description

Creates a new tutorial below inst/tutorials/. Tutorials are interactive R Markdown documents built with the learnr package. use_tutorial() does this setup:

Usage

1
use_tutorial(name, title, open = rlang::is_interactive())

Arguments

name

Base for file name to use for new .Rmd tutorial. Should consist only of numbers, letters, _ and -. We recommend using lower case.

title

The human-facing title of the tutorial.

open

Open the newly created file for editing? Happens in RStudio, if applicable, or via utils::file.edit() otherwise.

See Also

The learnr package documentation.

Examples

1
2
3
4
## Not run: 
use_tutorial("learn-to-do-stuff", "Learn to do stuff")

## End(Not run)

usethis documentation built on Oct. 25, 2021, 9:06 a.m.