getDesignRiskRatioFM {lrstat}

Group sequential design for two-sample risk ratio based on the Farrington-Manning score test

Description

Obtains the power given sample size or obtains the sample size given power for a group sequential design for two-sample risk ratio based on the Farrington-Manning score test

Usage

getDesignRiskRatioFM(
  beta = NA_real_,
  n = NA_real_,
  riskRatioH0 = 1,
  pi1 = NA_real_,
  pi2 = NA_real_,
  nullVariance = TRUE,
  allocationRatioPlanned = 1,
  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_
)

Arguments

beta

The type II error.

n

The total sample size.

riskRatioH0

The risk ratio under the null hypothesis. Defaults to 1.

pi1

The assumed probability for the active treatment group.

pi2

The assumed probability for the control group.

nullVariance

Whether to use the variance under the null or the empirical variance under the alternative.

allocationRatioPlanned

Allocation ratio for the active treatment versus control. Defaults to 1 for equal randomization.

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 (1:kMax) / kMax if left unspecified.

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, ..., kMax-1. Defaults to rep(-6, kMax-1) if left unspecified. The futility bounds are non-binding for the calculation of critical values.

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 kMax for the error spending time at each analysis. Defaults to missing, in which case, it is the same as informationRates.

Value

An S3 class designRiskRatioFM 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.

  • riskRatioH0: The risk ratio under the null hypothesis.

  • pi1: The assumed probability for the active treatment group.

  • pi2: The assumed probability for the control group.

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

  • efficacyRiskRatioScore: The efficacy boundaries on the score test pi1 - riskRatioH0*pi2 score.

  • futilityRiskRatioScore: The futility boundaries on the score test pi1 - riskRatioH0*pi2 scale.

  • numberOfSubjects: The number of subjects.

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

  • varianceRatio: The ratio of the variance under H0 to the variance under H1.

  • nullVariance: Whether to use the variance under the null or the empirical variance under the alternative.

  • allocationRatioPlanned: Allocation ratio for the active treatment versus control.

  • rounding: Whether to round up sample size.

Author(s)

Kaifeng Lu, [e-mail]

Examples

(design1 <- getDesignRiskRatioFM(
  beta = 0.2, riskRatioH0 = 1.3, pi1 = 0.125, pi2 = 0.125,
  alpha = 0.05))