getOverallPower: Calculate the overall power

View source: R/getOverallPower.R

getOverallPowerR Documentation

Calculate the overall power

Description

Calculate the overall power and other operating characteristics of a design.

Usage

getOverallPower(design, alternative)

Arguments

design

An object of class TrialDesignOptimalConditionalError created by getDesignOptimalConditionalErrorFunction(). Contains all necessary arguments to calculate the optimal conditional error function for the specified case.

alternative

Assumed relative effect size.

Details

This function is used to evaluate the overall performance of a design. The probabilities for first-stage futility, first-stage efficacy and overall efficacy (i.e., overall power) are saved in an object of class PowerResultsOptimalConditionalError.

Value

The overall power of the design at the provided effect size.

See Also

getDesignOptimalConditionalErrorFunction(), getSimulationResults()

Examples

# Get a design
design <- getDesignOptimalConditionalErrorFunction(
alpha = 0.025, alpha1 = 0.001, alpha0 = 0.5, conditionalPower = 0.9,
delta1 = 0.25, likelihoodRatioDistribution = "fixed", deltaLR = 0.25,
firstStageInformation = 80, useInterimEstimate = FALSE,
)

getOverallPower(design, alternative = 0.25)


optconerrf documentation built on Sept. 9, 2025, 5:29 p.m.