plot.delayedGSD: Display boundaries over information

View source: R/plot.delayedGSD.R

plot.delayedGSDR Documentation

Display boundaries over information

Description

Display boundaries over information

Usage

## S3 method for class 'delayedGSD'
plot(
  x,
  y,
  type = "Z",
  Itype = "rate",
  planned = NULL,
  predicted = TRUE,
  main = NULL,
  xlim = NULL,
  ylim = NULL,
  legend = TRUE,
  legend.x = NULL,
  legend.ncol = 1,
  legend.cex = 1,
  add.arrow = FALSE,
  sep.arrow = c(0.2, 0.1),
  size.arrow = 0.1,
  lwd.arrow = 1,
  cex.bound = 1.2,
  cex.estimate = 1.2,
  ...
)

Arguments

x

object from CalcBoundaries

y

not used. For compatibility with the generic method.

type

type of boundaries to plot (Z-statistic (Z), p-value (P), effect (E))

Itype

information scale on x-axis (rate or absolute (abs))

planned

[logical] should the planned boundaries be displayed along with the boundaries that have been computed based on the data. Can also be "only" to only display planned boundaries.

predicted

[logical] Should the predicted information/boundaries at decision based on interim data be output (when relevant).

main

to specify a plot title

xlim

range of the x axis

ylim

range of the y axis

legend

should a caption be added?

legend.x

location of the legend on the plot.

legend.ncol

number of column in the caption

legend.cex

character expansion factor for the text in the legend.

add.arrow

[logical] should arrows indicating the ordering of the space be added?

sep.arrow

[numeric vector of length 2] space between the critical point and the arrow (below and above)

size.arrow

[numeric, >0] width of the arrow.

lwd.arrow

[numeric, >0] thickness of the arrow.

cex.bound

[numeric, >0] size of the dots for the boundaries.

cex.estimate

[numeric vector of size 2] size of the dots for the estimated statistic/p-value/effect and its label.

...

not used. For compatibility with the generic method.

Examples

bnds <- CalcBoundaries(kMax=3, InfoR.i = c(0.5,0.75,1), InfoR.d = c(0.55,0.8))
plot(bnds, type = "Z")
plot(bnds, type = "Z", add.arrow = TRUE)
plot(bnds, type = "Z", add.arrow = TRUE, lwd.arrow=2,ylim=c(0.35,2.6), xlim=c(0.5,1.1),legend=FALSE)
plot(bnds, type = "E")
plot(bnds, type = "P")

paulowhite/DelayedGSD documentation built on Nov. 1, 2023, 5:36 p.m.