Skip to contents

Lists the names a declare_notes() step declares and the expression each is computed from. Unlike design_parameters(), no value is reported: a note has one only while the design is running, and a note computed from data has a different one on every draw.

The two functions divide a design's names between them. What design_parameters() lists can be changed with redesign(); what design_notes() lists cannot, and follows from what can.

Usage

design_notes(design)

Arguments

design

(required) A design or a design_step.

Value

A data frame with one row per note and columns name, expr (the expression, as a character label), and step (the position of the step that declares it).

Examples

design <- declare_parameters(m_arms = 3) +
  declare_notes(ks = seq_len(m_arms)[-1]) +
  declare_model(N = 60)
design_notes(design)
#>   name                expr step
#> 1   ks seq_len(m_arms)[-1]    2