A class for simulation results rates.
allocationRatioPlannedThe planned allocation ratio (n1 / n2) for the groups. For multi-arm designs, it is the allocation ratio relating the active arm(s) to the control. Is a single positive numeric value.
calcSubjectsFunctionAn optional function that can be entered to define how sample size is recalculated. By default, recalculation is performed with conditional power with specified minNumberOfSubjectsPerStage and maxNumberOfSubjectsPerStage.
conditionalPowerThe conditional power at each stage of the trial. Is a single numeric value between 0 and 1.
conditionalPowerAchievedThe calculated conditional power, under the assumption of observed or assumed effect sizes. Is a numeric matrix.
directionUpperSpecifies the direction of the alternative, only applicable for one-sided testing. Default is TRUE which means that larger values of the test statistics yield smaller p-values. Is a single logical value.
earlyStopThe probability to stopping the trial either for efficacy or futility. Is a numeric vector.
effectThe effect for randomly creating normally distributed responses. Is a numeric vector of length kMax.
expectedNumberOfSubjectsThe expected number of subjects under specified alternative.
futilityPerStageThe per-stage probabilities of stopping the trial for futility. Is a numeric matrix.
futilityStopIn simulation results data set: indicates whether trial is stopped for futility or not.
groupsThe group numbers. Is a numeric vector.
iterationsThe number of iterations used for simulations. Is a single numeric value representing a whole number.
maxNumberOfIterationsThe number of simulation iterations. Is a single numeric value representing a whole number.
maxNumberOfSubjectsThe maximum number of subjects for power calculations. Is a numeric vector.
normalApproximationDescribes if a normal approximation was used when calculating p-values. Default for means is FALSE and TRUE for rates and hazard ratio. Is a single logical value.
overallRejectThe overall rejection probability. Is a numeric vector.
pi1The assumed probability or probabilities in the active treatment group in two-group designs, or the alternative probability for a one-group design.
pi1H1The assumed probability in the active treatment group for two-group designs, or the assumed probability for a one treatment group design, for which the conditional power was calculated. Is a single numeric value between 0 and 1.
pi2The assumed probability in the reference group for two-group designs. Is a single numeric value between 0 and 1.
pi2H1The assumed probability in the reference group for two-group designs, for which the conditional power was calculated. Is a single numeric value between 0 and 1.
plannedSubjectsDetermines the number of cumulated (overall) subjects when the interim stages are planned. For two treatment arms, is the number of subjects for both treatment arms. For multi-arm designs, refers to the number of subjects per selected active arm. Is a numeric vector of length kMax containing whole numbers.
rejectPerStageThe probability to reject a hypothesis per stage of the trial. Is a numeric matrix.
riskRatioSpecifies if the sample size for one-sided testing of H0: pi1 / pi2 = thetaH0 has been calculated. Is a single logical value.
sampleSizesThe sample sizes for each group and stage. Is a numeric vector of length number of stages times number of groups containing whole numbers.
seedThe seed used for random number generation. Is a single numeric value.
thetaH0The difference or assumed effect under H0. Is a single numeric value.
Use getSimulationRates()
to create an object of this type.
SimulationResultsRates is the basic class for
SimulationResultsRates,
SimulationResultsMultiArmRates, and
SimulationResultsEnrichmentRates.