connect_box: Connect grob box with arrow.

Description Usage Arguments Value Examples

View source: R/connect_box.R

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

1
connect_box(start, end, connect, type = c("s", "p"), name = NULL)

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.

Value

A lines grob with arrow.

Examples

1
2
3
4
5
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")

consort documentation built on Dec. 21, 2021, 1:06 a.m.