Skip to contents

Creates a STROBE flow diagram from the filtering log recorded via strobe_initialize() and strobe_filter(). The main inclusion path flows top-to-bottom, and exclusions are drawn as horizontal arrows pointing to dashed boxes to the right, originating from the connecting lines.

Usage

plot_strobe_diagram(
  export_file = NULL,
  incl_width_min = 3,
  incl_height = NULL,
  excl_width_min = 2.5,
  excl_height = NULL,
  incl_fontsize = 14,
  excl_fontsize = 12,
  lock_width_min = FALSE,
  lock_height = FALSE
)

Arguments

export_file

Optional file path (e.g., "diagram.png" or "diagram.svg") to save the diagram.

incl_width_min

Width of inclusion boxes in inches. If NULL, auto-sizes to content.

incl_height

Height of inclusion boxes in inches. If NULL, auto-sizes to content.

excl_width_min

Width of exclusion boxes in inches. If NULL, auto-sizes to content.

excl_height

Height of exclusion boxes in inches. If NULL, auto-sizes to content.

incl_fontsize

Font size for inclusion box text (default = 14).

excl_fontsize

Font size for exclusion box text (default = 12).

lock_width_min

Logical. If TRUE, treats incl_width_min and excl_width_min as minimum widths. Due to Graphviz limitations, widths are lower bounds only— content may still expand boxes beyond these values.

lock_height

Logical. If TRUE, enforces exact box heights for all nodes.

Value

A DiagrammeR graph object representing the STROBE diagram.