run_example: Run an Example Script

View source: R/examples_helpers.R

run_exampleR Documentation

Run an Example Script

Description

Executes an example script bundled in the package ⁠inst/examples/⁠ folder.

Usage

run_example(example_name, echo = TRUE)

Arguments

example_name

Character scalar with the example filename (e.g. "basic.R").

echo

Logical; print code as it runs (default TRUE).

Value

Invisibly returns NULL. Runs the example for its side effects.

Examples



# Example (requires a real file under inst/examples):
# run_example("basic.R")



PortfolioTesteR documentation built on Nov. 5, 2025, 5:23 p.m.