connect_box: Connect grob box with arrow.

In consort: Create Consort Diagram

Connect grob box with arrow.

Description

This function is used to create an arrow line to connect two boxes. User should provide the starting and ending side of the arrow.

Usage

connect_box(
  start,
  end,
  connect,
  type = c("s", "p"),
  name = NULL,
  arrow_gp = consort_opt("arrow_gp"),
  arrow_length = consort_opt("arrow_length"),
  arrow_type = consort_opt("arrow_type")
)

Arguments

start	Starting point of the arrow.
end	Ending point of the arrow.
connect	The connection of the box. It should be the combination of the position. The t refers to "top", l for "left", b for "bottom" and r for "right". The first letter is the starting point of the start box, the second is the ending point of the end box. For example, if one wants to connect the left side of the start box with right side of the left side of the end box, the value should be "lr". All the connection will be started in the middle point.
type	Should be one the "s" (strait line), or "p" (polyline).
name	A character identifier of the line grob, passed to linesGrob.
arrow_gp	Graphical parameters gpar object for the connector line. Defaults to grid::gpar(col = "black", lwd = 1).
arrow_length	Length of the arrowhead as a unit object. Defaults to unit(0.1, "inches").
arrow_type	Arrow type, either "closed" or "open". Defaults to "closed".

Value

A lines grob with arrow.

Examples

fg1 <- textbox(text = "This is a test")
fg2 <- textbox(text = "This is an other test", 0.7, 0.2)
grid::grid.draw(fg1)
grid::grid.draw(fg2)
connect_box(fg1, fg2, connect = "bl", type = "p")

# Customize line width and color
connect_box(fg1, fg2, connect = "bl", type = "p", arrow_gp = grid::gpar(lwd = 2, col = "red"))

# Or set globally via set_consort_defaults
set_consort_defaults(arrow_gp = grid::gpar(lwd = 2, col = "blue"))

consort documentation built on April 26, 2026, 9:06 a.m.