panel_note: Create a note for a diyPaths panel

View source: R/diyPaths.R

panel_noteR Documentation

Create a note for a diyPaths panel

Description

Helper function that creates a list of arguments which specify a custom note, displayed as a caption beneath its target panel, designed for use within the panel_notes argument of diyPaths(). Use the show_group_labels argument in diyPaths() to view each panel's number and which group it refers to.

Usage

panel_note(panel_num, note_text = NULL)

Arguments

panel_num

Integer value for the panel number this note applies to.

note_text

Text to display in the note. If NULL, no note is drawn.

Value

A list containing arguments that specify a panel's note text, for use within the panel_notes argument of diyPaths().

See Also

diyPaths(), where the list of notes is passed to panel_notes; panel_title() for adding titles to panels; template(), whose output includes a starting note list.

Examples

# a note on the first panel noting sample size was 100.
panel_note(panel_num = 1, note_text = "n = 100")

# a note on the second panel of a multi-group model noting sample size for Group 2 was 50
panel_note(panel_num = 2, note_text = "Group 2: n = 50")


diy.sem.plot documentation built on Nov. 11, 2026, 1:11 a.m.