View source: R/getDesignMeans.R
getDesignMeanRatio | R Documentation |
Obtains the power given sample size or obtains the sample size given power for a group sequential design for two-sample mean ratio.
getDesignMeanRatio(
beta = NA_real_,
n = NA_real_,
meanRatioH0 = 1,
meanRatio = 1.25,
CV = 1,
allocationRatioPlanned = 1,
normalApproximation = TRUE,
rounding = TRUE,
kMax = 1L,
informationRates = NA_real_,
efficacyStopping = NA_integer_,
futilityStopping = NA_integer_,
criticalValues = NA_real_,
alpha = 0.025,
typeAlphaSpending = "sfOF",
parameterAlphaSpending = NA_real_,
userAlphaSpending = NA_real_,
futilityBounds = NA_real_,
typeBetaSpending = "none",
parameterBetaSpending = NA_real_,
userBetaSpending = NA_real_,
spendingTime = NA_real_
)
beta |
The type II error. |
n |
The total sample size. |
meanRatioH0 |
The mean ratio under the null hypothesis. Defaults to 1. |
meanRatio |
The mean ratio under the alternative hypothesis. |
CV |
The coefficient of variation. The standard deviation on the
log scale is equal to |
allocationRatioPlanned |
Allocation ratio for the active treatment versus control. Defaults to 1 for equal randomization. |
normalApproximation |
The type of computation of the p-values.
If |
rounding |
Whether to round up sample size. Defaults to 1 for sample size rounding. |
kMax |
The maximum number of stages. |
informationRates |
The information rates. Fixed prior to the trial.
Defaults to |
efficacyStopping |
Indicators of whether efficacy stopping is allowed at each stage. Defaults to true if left unspecified. |
futilityStopping |
Indicators of whether futility stopping is allowed at each stage. Defaults to true if left unspecified. |
criticalValues |
Upper boundaries on the z-test statistic scale for stopping for efficacy. |
alpha |
The significance level. Defaults to 0.025. |
typeAlphaSpending |
The type of alpha spending. One of the following: "OF" for O'Brien-Fleming boundaries, "P" for Pocock boundaries, "WT" for Wang & Tsiatis boundaries, "sfOF" for O'Brien-Fleming type spending function, "sfP" for Pocock type spending function, "sfKD" for Kim & DeMets spending function, "sfHSD" for Hwang, Shi & DeCani spending function, "user" for user defined spending, and "none" for no early efficacy stopping. Defaults to "sfOF". |
parameterAlphaSpending |
The parameter value for the alpha spending. Corresponds to Delta for "WT", rho for "sfKD", and gamma for "sfHSD". |
userAlphaSpending |
The user defined alpha spending. Cumulative alpha spent up to each stage. |
futilityBounds |
Lower boundaries on the z-test statistic scale
for stopping for futility at stages 1, ..., |
typeBetaSpending |
The type of beta spending. One of the following: "sfOF" for O'Brien-Fleming type spending function, "sfP" for Pocock type spending function, "sfKD" for Kim & DeMets spending function, "sfHSD" for Hwang, Shi & DeCani spending function, "user" for user defined spending, and "none" for no early futility stopping. Defaults to "none". |
parameterBetaSpending |
The parameter value for the beta spending. Corresponds to rho for "sfKD", and gamma for "sfHSD". |
userBetaSpending |
The user defined beta spending. Cumulative beta spent up to each stage. |
spendingTime |
A vector of length |
An S3 class designMeanRatio
object with three components:
overallResults
: A data frame containing the following variables:
overallReject
: The overall rejection probability.
alpha
: The overall significance level.
attainedAlpha
: The attained significance level, which is
different from the overall significance level in the presence of
futility stopping.
kMax
: The number of stages.
theta
: The parameter value.
information
: The maximum information.
expectedInformationH1
: The expected information under H1.
expectedInformationH0
: The expected information under H0.
drift
: The drift parameter, equal to
theta*sqrt(information)
.
inflationFactor
: The inflation factor (relative to the
fixed design).
numberOfSubjects
: The maximum number of subjects.
expectedNumberOfSubjectsH1
: The expected number of subjects
under H1.
expectedNumberOfSubjectsH0
: The expected number of subjects
under H0.
meanRatioH0
: The mean ratio under the null hypothesis.
meanRatio
: The mean ratio under the alternative hypothesis.
CV
: The coefficient of variation.
byStageResults
: A data frame containing the following variables:
informationRates
: The information rates.
efficacyBounds
: The efficacy boundaries on the Z-scale.
futilityBounds
: The futility boundaries on the Z-scale.
rejectPerStage
: The probability for efficacy stopping.
futilityPerStage
: The probability for futility stopping.
cumulativeRejection
: The cumulative probability for efficacy
stopping.
cumulativeFutility
: The cumulative probability for futility
stopping.
cumulativeAlphaSpent
: The cumulative alpha spent.
efficacyP
: The efficacy boundaries on the p-value scale.
futilityP
: The futility boundaries on the p-value scale.
information
: The cumulative information.
efficacyStopping
: Whether to allow efficacy stopping.
futilityStopping
: Whether to allow futility stopping.
rejectPerStageH0
: The probability for efficacy stopping
under H0.
futilityPerStageH0
: The probability for futility stopping
under H0.
cumulativeRejectionH0
: The cumulative probability for
efficacy stopping under H0.
cumulativeFutilityH0
: The cumulative probability for futility
stopping under H0.
numberOfSubjects
: The number of subjects.
efficacyMeanRatio
: The efficacy boundaries on the mean
ratio scale.
futilityMeanRatio
: The futility boundaries on the mean
ratio scale.
settings
: A list containing the following input parameters:
typeAlphaSpending
: The type of alpha spending.
parameterAlphaSpending
: The parameter value for alpha
spending.
userAlphaSpending
: The user defined alpha spending.
typeBetaSpending
: The type of beta spending.
parameterBetaSpending
: The parameter value for beta spending.
userBetaSpending
: The user defined beta spending.
spendingTime
: The error spending time at each analysis.
allocationRatioPlanned
: Allocation ratio for the active
treatment versus control.
normalApproximation
: The type of computation of the p-values.
If TRUE
, the variance is assumed to be known, otherwise
the calculations are performed with the t distribution.
rounding
: Whether to round up sample size.
Kaifeng Lu, kaifenglu@gmail.com
(design1 <- getDesignMeanRatio(
beta = 0.1, n = NA, meanRatio = 1.25, CV = 0.25,
alpha = 0.05, normalApproximation = FALSE))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.