legendbox: Draw a box with text explaining the numbers in and between...

In Epi: Statistical Analysis in Epidemiology

Draw a box with text explaining the numbers in and between boxes from boxes.MS and boxes.Lexis

Description

When drawing boxes describing a multistate model a legend explaining the numbers in the plot is required. legendbox does this.

Usage

legendbox(x, y,
         state = "State",
            py = "Person-time",
         begin = "no. begin",
           end = "no. end",
         trans = "Transitions",
         rates = "\n(Rate)",
          font = 1,
         right = !left,
          left = !right,
           ...)

Arguments

x	x-coordinate of the center of the box.
y	y-coordinate of the center of the box.
state	Text describing the state
py	Text describing the risk time
begin	Text describing the no. persons starting FU in state
end	Text describing the no. persons ending FU in state
trans	Text describing the no. of transitions
rates	Text describing the rates
font	Font to use for the text
right	Should a text describing arrow texts be on the r.h.s. of the box? Defaults to TRUE.
left	Should a text describing arrow texts be on the l.h.s. of the box?
...	Arguments passed on to tbox

Details

The function is called for its side effect of adding an explanatory box to the plot. If right is true, an explanation of events and rates are added to the right of the box. Similarly for left. It is admissible that left == right.

Value

None.

Author(s)

Bendix Carstensen, http://bendixcarstensen.com

See Also

boxes.Lexis

Epi documentation built on Oct. 1, 2024, 5:07 p.m.