orderly_example_show: Show an example file

In orderly: Lightweight Reproducible Reporting

Show an example file

Description

Show a file from within one of the examples. This function exists for use within orderly help files, vignettes and tutorials and is not meant to form part of your workflows, unless you are doing something very peculiar.

Usage

orderly_example_show(name, file = NULL, example = "demo")

Arguments

name	The name of the report within the example.
file	The name of the file within the report. The default is to show the main orderly file (i.e., ⁠<name>.R⁠)
example	The name of the example to look in. The default demo is a sprawling set of source designed to show off different orderly features.

Details

All orderly examples here are runnable, though some will naturally have some pre-requisites (e.g., using a dependency will require that the dependency has been run first).

Value

Nothing, called for its side effects only.

Examples

# We use constructions like this in the help, to show off features
# of orderly:
orderly_example_show("data")

# You can run this example:
path <- orderly_example()
orderly_run("data", root = path)

orderly documentation built on Jan. 24, 2026, 1:07 a.m.