Copy the worked example report into a folder

Drops the package's complete worked example next to your data: a full Quarto report over the bundled podracing_survey (every chart type, real narrative) plus the matching slide-deck script on the officer path. Render / run them as they are, then swap in your own data.

Usage

example_report(dir = "ezrsurvey-example", overwrite = FALSE)

Arguments

dir

Destination folder. Defaults to "ezrsurvey-example" in the working directory; created if missing.

overwrite

Overwrite existing files of the same names. Defaults to FALSE.

Value

Invisibly the paths written.

Details

Two files are copied: podracing-report.qmd (render with quarto render podracing-report.qmd) and podracing-deck.R (run with Rscript podracing-deck.R; writes a 16:9 deck to ezrsurvey-outputs/). Unlike the blank scaffold_report() skeletons, the example ships finished narrative over the bundled data, so you can see every visual and slide element in a finished state before adapting it.

See also

scaffold_report() for blank skeletons, report_deck().

Other reporting: list_report_templates(), report_add_plot(), report_add_slide(), report_add_table(), report_add_text(), report_deck(), report_layouts(), report_new(), report_save(), report_section(), report_slide(), report_title_slide(), scaffold_report()

Examples

dir <- file.path(tempdir(), "ezrsurvey-example")
example_report(dir)
#> Example written to /tmp/RtmpjqnV9l/ezrsurvey-example/ -- start with podracing-report.qmd.
list.files(dir)
#> [1] "podracing-deck.R"     "podracing-report.qmd"

# then render it:
# quarto::quarto_render("ezrsurvey-example/podracing-report.qmd")