casestudy: Render a case study to HTML

In s20x: Functions for University of Auckland Course STATS 201/208 Data Analysis

Render a case study to HTML

Description

Renders a specified case study R Markdown file shipped with the package to HTML and optionally opens it in a web browser.

Usage

casestudy(
  id,
  output_dir = tempfile("s20x_case_study_"),
  open = interactive(),
  quiet = TRUE,
  ...
)

cs(...)

Arguments

id	A case study identifier. Flexible formats are accepted, including "CS9_2", "CS9.2", "9_2", or "9.2".
output_dir	Directory where the rendered HTML file should be written. Defaults to a temporary directory.
open	Logical; if TRUE (default), open the rendered HTML file in the default web browser.
quiet	Logical; passed to rmarkdown::render() to suppress output.
...	Additional arguments passed to rmarkdown::render().

Details

Case studies are expected to live in inst/case_studies and to be named using the pattern CS<chapter>_<number>.Rmd (for example, CS9_2.Rmd).

The case study is rendered on demand using rmarkdown::render(). Figures and other outputs are generated at render time; users therefore need any required packages installed for the selected case study.

The rendered HTML file is returned invisibly.

Value

Invisibly returns the path to the rendered HTML file.

Examples

## Not run: 
casestudy("CS9_2")
casestudy("9.2")
cs("9_2")

## End(Not run)

s20x documentation built on Jan. 14, 2026, 9:07 a.m.