summary.delayedGSD: Status of a Group Sequential Design with Delayed Endpoints

View source: R/summary.delayedGSD.R

summary.delayedGSDR Documentation

Status of a Group Sequential Design with Delayed Endpoints

Description

Display boundaries and estimated treatment effect up the current stage.

Usage

## S3 method for class 'delayedGSD'
summary(
  x,
  planned = NULL,
  predicted = TRUE,
  digits = 5,
  space = "|",
  abreviated = TRUE,
  ...
)

Arguments

x

object of class delayedGSD, typically output from CalcBoundaries.

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).

digits

[interger,>0] integer indicating the number of decimal places to be used.

space

[character] column separator.

abreviated

[logical] abreviate some column names and action that should be taken (e.g. C for continue, C-Info for continue due to decreasing information, S-F for stop for futility, and S-Imax for stop because maximum information has been reached).

...

not used, for compatibility with the generic method.


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