build_boilerplate_md: Build the Markdown methods boilerplate for an eyeris object

In eyeris: Flexible, Extensible, & Reproducible Pupillometry Preprocessing

Build the Markdown methods boilerplate for an eyeris object

Description

Internal worker that assembles the full Markdown boilerplate body (note, methods prose, reproducibility/sidecar reference, citation, and license). Used both by the exported boilerplate() function and by the HTML report generator.

Usage

build_boilerplate_md(
  eyeris,
  version = NULL,
  n_runs = NULL,
  include_citation = TRUE,
  include_license = TRUE
)

Arguments

eyeris	An eyeris object
version	Optional eyeris version string; defaults to the installed version
n_runs	Optional integer number of recording blocks/runs; inferred from the object when NULL
include_citation	Logical; whether to append a citation
include_license	Logical; whether to append the CC BY 4.0 license note

Value

A length-one character string of Markdown

eyeris documentation built on Aug. 1, 2026, 1:07 a.m.