A class for simulation results survival in multi-arm designs.
accrualIntensityThe absolute accrual intensities. Is a numeric vector of length kMax.
accrualTimeThe assumed accrual time intervals for the study. Is a numeric vector.
activeArmsThe number of active treatment arms to be compared with control. Is a single numeric value representing a whole number.
adaptationsIndicates whether or not an adaptation takes place at interim k. Is a logical vector of length kMax minus 1.
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.
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.
correlationComputationIf "alternative", a correlation matrix according to Deng et al. (Biometrics, 2019) accounting for the respective alternative is used for simulating log-rank statistics in the many-to-one design. If "null", a constant correlation matrix valid under the null hypothesis is used.
cumulativeEventsPerStageThe cumulative number of events per stage. 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.
dropoutRate1The assumed drop-out rate in the treatment group. Is a single numeric value between 0 and 1.
dropoutRate2The assumed drop-out rate in the control group. Is a single numeric value between 0 and 1.
dropoutTimeThe assumed time for drop-out rates in the control and treatment group. Is a single numeric value.
observedDropoutProportion1Mean replication-specific cumulative observed dropout proportion in arm 1 at each stage, counting dropout before the event and by that stage's analysis time. Only replications contributing at that stage with a finite analysis time and positive enrolled-subject denominator contribute; NA if none contribute. Stopped trials and discontinued groups do not contribute to later stages; overlapping populations include their shared subjects. Numeric matrices with stage rows and scenario columns for two-arm trials. In multi-arm trials, arm 1 has dimensions stage, scenario, and active arm; arm 2 is a stage-by-scenario matrix for shared control. In enrichment trials, both arms have dimensions stage, scenario, and population (subpopulations followed by the full population). A single active arm or population uses a stage-by-scenario matrix. Stage and scenario dimensions are always retained. NULL for test-statistic-based simulation. Both proportions are hidden in print and summary output when both input dropout rates are zero, but remain in the object.
observedDropoutProportion2Mean replication-specific cumulative observed dropout proportion in arm 2 at each stage, counting dropout before the event and by that stage's analysis time. Only replications contributing at that stage with a finite analysis time and positive enrolled-subject denominator contribute; NA if none contribute. Stopped trials and discontinued groups do not contribute to later stages; overlapping populations include their shared subjects. Numeric matrices with stage rows and scenario columns for two-arm trials. In multi-arm trials, arm 1 has dimensions stage, scenario, and active arm; arm 2 is a stage-by-scenario matrix for shared control. In enrichment trials, both arms have dimensions stage, scenario, and population (subpopulations followed by the full population). A single active arm or population uses a stage-by-scenario matrix. Stage and scenario dimensions are always retained. NULL for test-statistic-based simulation. Both proportions are hidden in print and summary output when both input dropout rates are zero, but remain in the object.
dropoutObservationTime1Mean stage analysis time in arm 1 over exactly the replications contributing to the corresponding stage's observed dropout proportion, in the same units as accrual and survival times. NA if no replication contributes. Numeric matrices with stage rows and scenario columns for two-arm trials. In multi-arm trials, arm 1 has dimensions stage, scenario, and active arm; arm 2 is a stage-by-scenario matrix for shared control. In enrichment trials, both arms have dimensions stage, scenario, and population (subpopulations followed by the full population). A single active arm or population uses a stage-by-scenario matrix. Stage and scenario dimensions are always retained. NULL for test-statistic-based simulation. Retained in the object but omitted from print and summary output.
dropoutObservationTime2Mean stage analysis time in arm 2 over exactly the replications contributing to the corresponding stage's observed dropout proportion, in the same units as accrual and survival times. NA if no replication contributes. Numeric matrices with stage rows and scenario columns for two-arm trials. In multi-arm trials, arm 1 has dimensions stage, scenario, and active arm; arm 2 is a stage-by-scenario matrix for shared control. In enrichment trials, both arms have dimensions stage, scenario, and population (subpopulations followed by the full population). A single active arm or population uses a stage-by-scenario matrix. Stage and scenario dimensions are always retained. NULL for test-statistic-based simulation. Retained in the object but omitted from print and summary output.
earlyStopThe probability to stopping the trial either for efficacy or futility. Is a numeric vector.
effectMatrixThe matrix of effect sizes with activeArms columns and number of rows reflecting the different situations to consider.
epsilonValueNeeds to be specified if typeOfSelection = "epsilon". Is a single numeric value.
eventsPerStageDeprecated: use singleEventsPerStage or cumulativeEventsPerStage instead Is a numeric matrix.
eventTimeThe assumed time under which the event rates are calculated. Is a single numeric value.
expectedNumberOfEventsThe expected number of events under specified alternative. Is a numeric vector.
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.
gED50The ED50 of the sigmoid Emax model. Only necessary if typeOfShape = "sigmoidEmax" has been specified. Is a single numeric value.
intersectionTestThe multiple test used for intersection hypotheses in closed systems of hypotheses. Is a single character value.
iterationsThe number of iterations used for simulations. Is a single numeric value representing a whole number.
kappaThe shape of the Weibull distribution if kappa!=1. Is a single numeric value.
maxNumberOfEventsPerStageDetermines the maximum number of events per stage for data-driven sample size recalculation. Is a numeric vector of length kMax containing whole numbers.
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.
minNumberOfEventsPerStageDetermines the minimum number of events per stage for data-driven sample size recalculation. Is a numeric vector of length kMax containing whole numbers.
numberOfSelectedArmsThe number of selected arms in a multi-armed design. Is a numeric matrix.
omegaMaxVectorThe range of hazard ratios with highest response for "linear" and "sigmoidEmax" model. Is a numeric vector.
plannedEventsDetermines the number of cumulated (overall) events in survival designs when the interim stages are planned. For two treatment arms, is the number of events for both treatment arms. For multi-arm designs, refers to the overall number of events for the selected arms plus control. Is a numeric vector of length kMax containing whole numbers.
rejectAtLeastOneThe probability to reject at least one of the (multiple) hypotheses. Is a numeric vector.
rejectedArmsPerStageThe simulated number of rejected arms per stage.
rValueNeeds to be specified if typeOfSelection = "rBest". Is a single numeric value.
seedThe seed used for random number generation. Is a single numeric value.
selectArmsFunctionAn optional function that can be entered to define how treatment arms are selected.
selectedArmsThe selected arms in multi-armed designs.
singleEventsPerArmAndStageThe number of events per arm and stage that is used for the analysis.
singleEventsPerStageThe single number of events per stage. Is a numeric matrix.
singleNumberOfEventsPerStageDeprecated: use singleEventsPerArmAndStage or singleEventsPerSubsetAndStage instead
simulationTypeThe simulation approach used: "patientWise" or
"testStatisticBased".
slopeThe slope of the sigmoid Emax model, if typeOfShape = "sigmoidEmax" Is a single numeric value.
studyDurationThe study duration for specified effect size. Is a positive numeric vector.
thetaH0The difference or assumed effect under H0. Is a single numeric value.
successPerStageThe simulated success probabilities per stage where success is defined by user. Is a numeric matrix.
thresholdThe selection criterion: treatment arm/population is only selected if effectMeasure exceeds threshold. Either a single numeric value or a numeric vector of length activeArms referring to a separate threshold condition for each treatment arm.
typeOfShapeThe shape of the dose-response relationship over the treatment groups. Is a single character value.
lambdaTreatmentThe assumed hazard rate in the active arm. Is a numeric vector of length number of stages times number of groups.
lambdaControlThe assumed hazard rate in the reference group. Is a single numeric value.
medianTreatmentThe assumed median survival time in the active arm. Is a numeric vector of length number of stages times number of groups.
medianControlThe assumed median survival time in the reference group. Is a single numeric value.
analysisTimeThe estimated time of analysis. Is a numeric matrix.
effectMeasureCriterion for treatment arm/population selection, either based on test statistic ("testStatistic") or effect estimate ("effectEstimate"). Is a single character value.
eventsNotAchievedThe simulated number of cases how often the number of events was not reached. Is a numeric matrix.
numberOfSubjectsIn simulation results data set: The number of subjects under consideration when the interim analysis takes place.
piControlThe assumed probability in the control arm for simulation and under which the sample size recalculation is performed. Is a single numeric value between 0 and 1.
piecewiseSurvivalTimeThe time intervals for the piecewise definition of the exponential survival time cumulative distribution function. Is a numeric vector.
successCriterionDefines when the study is stopped for efficacy at interim. "all" stops the trial if the efficacy criterion has been fulfilled for all selected treatment arms/populations, "atLeastOne" stops if at least one of the selected treatment arms/populations is shown to be superior to control at interim. Is a single character value.
typeOfSelectionThe way the treatment arms or populations are selected at interim. Is a single character value.
calcEventsFunctionAn optional function that can be entered to define how event size is recalculated. By default, recalculation is performed with conditional power with specified minNumberOfEventsPerStage and maxNumberOfEventsPerStage.
thetaH1The assumed effect under the alternative hypothesis. For survival designs, refers to the hazard ratio. Is a numeric vector.
maxStudyDurationThe maximum study duration in survival designs. Is a numeric vector.
doseLevelsDose levels supplied for the dose-response relationship, one per active arm. Numeric vector, or NULL when a user-defined effect matrix is used.
numberOfActiveArmsDeprecated alias of numberOfSelectedArms. Numeric matrix with stage rows and scenario columns, giving the mean number of selected active arms at each analysis.
Use getSimulationMultiArmSurvival()
to create an object of this type.