as.data.frame.TrialDesignSet: Coerce Trial Design Set to a Data Frame

In rpact: Confirmatory Adaptive Clinical Trial Design and Analysis

Coerce Trial Design Set to a Data Frame

Description

Returns the TrialDesignSet as data frame.

Usage

## S3 method for class 'TrialDesignSet'
as.data.frame(
  x,
  row.names = NULL,
  optional = FALSE,
  niceColumnNamesEnabled = FALSE,
  includeAllParameters = FALSE,
  addPowerAndAverageSampleNumber = FALSE,
  theta = seq(-1, 1, 0.02),
  nMax = NA_integer_,
  ...
)

Arguments

x	A TrialDesignSet object.
niceColumnNamesEnabled	Logical. If TRUE, nice looking column names will be used; syntactic names (variable names) otherwise (see make.names).
includeAllParameters	Logical. If TRUE, all available parameters will be included in the data frame; a meaningful parameter selection otherwise, default is FALSE.
addPowerAndAverageSampleNumber	If TRUE, power and average sample size will be added to data frame, default is FALSE.
theta	A vector of standardized effect sizes (theta values), default is a sequence from -1 to 1.
nMax	The maximum sample size. Must be a positive integer of length 1.
...	Ensures that all arguments (starting from the "...") are to be named and that a warning will be displayed if unknown arguments are passed.

Details

Coerces the design set to a data frame.

Value

Returns a data.frame.

Examples

designSet <- getDesignSet(design = getDesignGroupSequential(), alpha = c(0.01, 0.05))
as.data.frame(designSet)

rpact documentation built on July 9, 2023, 6:30 p.m.