plotRecruit: A recruitment plot for a gsearly model

In gsearly: Creates Group Sequential Trial Designs when Early Outcomes are Available

A recruitment plot for a gsearly model

Description

A recruitment plot for a gsearly model.

Usage

plotRecruit(mod, xlim=NA, ylim=NA, xlab=NA, ylab=NA, title=NULL, col=NA,
    lty=c(1,2), pch=3, las=1, wopcol=grey(0.9), intlab=NA, labpos=3,
    legpos="topleft", tlag=c(0,0), pcol=1, ...)

Arguments

mod	A gsearly model from function gsearlyModel or gsearlyUser functions.
xlim	The x limits c(x1, x2) of the plot; default NA.
ylim	The y limits of the plot; default NA.
xlab	A label for the x axis; defaults to "Time".
ylab	A label for the y axis; defaults to "Number Recruited".
title	A main title for the plot; default NULL.
col	Plotting colors for the lines showing recruited numbers; defaults to 1:mod$rdata$s.
lty	A vector of length 2 indicating the line types for the lines showing numbers recruited and the interim analyses times; default c(1, 2).
pch	Plotting character or symbol for points; default 3.
las	A numeric value which is one of either 0, 1, 2 or 3; the style of axis labels, 0: always parallel to the axis, 1: always horizontal (default), 2: always perpendicular to the axis, 3: always vertical.
wopcol	Color for the window of opportunity region, default grey(0.9). Set to grey(1) for no color.
intlab	A vector of labels for the interim analyses; defaults to t[1], t[2], etc. Set to NULL, for no labels.
labpos	Position of interim labels; default 3.
legpos	Legend position is one of "bottomright", "bottom", "bottomleft", "left", "topleft", "top", "topright", "right" and "center"; default "topleft".
tlag	A vector of length 2, with positive values for time lags, pre-recruitment and post-recruitment, over which to extend the plotted lines; default c(0, 0).
pcol	Color for points and interim lines; default 1.
...	Further arguments to plot function.

Value

A plot of the selected type or a list consisting of the plotted line and interim point data and bounds for the window of opportunity.

Examples

 # For 90 percent power (pow), a call to gsearlyModel provides a feasible design
 fp <- c(0.0000,0.0010,0.0250)
 tn <- c(0.4800,0.7200,0.9750)
 rctdesign <- gsearlyModel(rmodel="dilin", trecruit=36, s=3, tfu=c(3,6,12),
                   tinterims=c(16,31), pow=0.8,
                   cmodel="exponential", sd=20, rho=0.75, theta=8, fp=fp, tn=tn)
 plotRecruit(rctdesign)

gsearly documentation built on July 10, 2026, 5:09 p.m.