describe_boilerplate_steps: Describe each recorded pipeline step as a methods-section...

View source: R/utils-boilerplate.R

describe_boilerplate_stepsR Documentation

Describe each recorded pipeline step as a methods-section sentence

Description

Walks an eyeris object's recorded params in canonical pipeline order and returns one prose sentence per step, with the actual parameter values substituted in. Unknown/custom steps are appended at the end.

Usage

describe_boilerplate_steps(params, info)

Arguments

params

The eyeris$params list (named by step suffix)

info

The eyeris$info list (used for context, e.g., sample rate)

Value

A character vector of sentences (possibly length 0)


eyeris documentation built on June 19, 2026, 9:08 a.m.