Skip to contents

Copy a demo's Quarto notebook so you can run and change it

Source: R/demo_library.R
sframe_demo_qmd.Rd

The code route through a demo is a notebook that renders to a report, which is what a research workflow looks like. This writes one for the named demo: load and validate the instrument and responses, inspect the complete ordered analysis plan, screen data quality, run the plan with status and plots, inspect each result and its reproducible syntax, compare the bundled expected results, render analysis and full reports, and export the data for checking elsewhere.

Usage

sframe_demo_qmd(name, dir = ".", overwrite = FALSE)

Arguments

name

Character. A demo name, as listed by sframe_demos().

dir

Directory to write into. Defaults to the working directory.

overwrite

Logical. Overwrite an existing file of the same name.

Value

The path written, invisibly.

See also

sframe_demo(), sframe_demos()

Examples

out <- sframe_demo_qmd("two_group", dir = tempdir())
#> Notebook written to: /tmp/Rtmp44tQ8U/two_group.qmd
basename(out)
#> [1] "two_group.qmd"