run_tutorial: Run a tutorial

In learnr: Interactive Tutorials for R

Run a tutorial

Description

Run a tutorial provided by an installed R package.

Usage

run_tutorial(
  name = NULL,
  package = NULL,
  ...,
  shiny_args = NULL,
  clean = FALSE,
  as_rstudio_job = NULL
)

Arguments

name	Tutorial name (subdirectory within tutorials/ directory of installed package). Alternatively, if package is not provided, name may be a path to a local tutorial R Markdown file or a local directory containing a learnr tutorial. If package is provided, name must be the tutorial name.
package	Name of package. If name is a path to the local directory containing a learnr tutorial, then package should not be provided.
...	Unused. Included for future expansion and to ensure named arguments are used.
shiny_args	Additional arguments to forward to shiny::runApp.
clean	When TRUE, the shiny prerendered HTML files are removed and the tutorial is re-rendered prior to starting the tutorial.
as_rstudio_job	Runs the tutorial in the background as an RStudio job. This is the default behavior when run_tutorial() detects that RStudio is available and can run jobs. Set to FALSE to disable and to run the tutorial in the current R session. When running as an RStudio job, run_tutorial() sets or overrides the launch.browser option for shiny_args. You can instead use the shiny.launch.browser global option in your current R session to set the default behavior when the tutorial is run. See the shiny options documentation for more information.

Value

Starts a Shiny server running the learnr tutorial.

See Also

safe and available_tutorials

Examples

# display all "learnr" tutorials
available_tutorials("learnr")

# run basic example within learnr
## Not run: 
run_tutorial("hello", "learnr")

## End(Not run)

learnr documentation built on Nov. 10, 2022, 5:43 p.m.