SimulationResultsEnrichmentSurvival: Class for Simulation Results Enrichment Survival
In rpact: Confirmatory Adaptive Clinical Trial Design and Analysis

SimulationResultsEnrichmentSurvival

R Documentation

Class for Simulation Results Enrichment Survival

Description

A class for simulation results survival in enrichment designs.

Details

Use getSimulationEnrichmentSurvival() to create an object of this type.

Fields

accrualIntensity: The absolute accrual intensities. Is a numeric vector of length kMax.
accrualTime: The assumed accrual time intervals for the study. Is a numeric vector.
adaptations: Indicates whether or not an adaptation takes place at interim k. Is a logical vector of length kMax minus 1.
allocationRatioPlanned: The 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 positive numeric vector of length 1.
calcEventsFunction: An 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.
conditionalPower: The conditional power at each stage of the trial. Is a numeric vector of length 1 containing a value between 0 and 1.
conditionalPowerAchieved: The calculated conditional power, under the assumption of observed or assumed effect sizes. Is a numeric matrix.
cumulativeEventsPerStage: The cumulative number of events per stage. Is a numeric matrix.
directionUpper: Specifies 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 logical vector of length 1.
dropoutRate1: The assumed drop-out rate in the treatment group. Is a numeric vector of length 1 containing a value between 0 and 1.
dropoutRate2: The assumed drop-out rate in the control group. Is a numeric vector of length 1 containing a value between 0 and 1.
dropoutTime: The assumed time for drop-out rates in the control and treatment group. Is a numeric vector of length 1.
earlyStop: The probability to stopping the trial either for efficacy or futility. Is a numeric vector.
effectList: The list of subsets, prevalences and effect sizes with columns and number of rows reflecting the different situations to be considered.
effectMeasure: Criterion for treatment arm/population selection, either based on test statistic ("testStatistic") or effect estimate ("effectEstimate"). Is a character vector of length 1.
epsilonValue: Needs to be specified if typeOfSelection = "epsilon". Is a numeric vector of length 1.
eventsPerStage: Deprecated: use singleEventsPerStage or cumulativeEventsPerStage instead Is a numeric matrix.
eventTime: The assumed time under which the event rates are calculated. Is a numeric vector of length 1.
expectedNumberOfEvents: The expected number of events under specified alternative. Is a numeric vector.
expectedNumberOfSubjects: The expected number of subjects under specified alternative.
futilityPerStage: The per-stage probabilities of stopping the trial for futility. Is a numeric matrix.
futilityStop: In simulation results data set: indicates whether trial is stopped for futility or not.
intersectionTest: The multiple test used for intersection hypotheses in closed systems of hypotheses. Is a character vector of length 1.
iterations: The number of iterations used for simulations. Is a numeric vector of length 1 containing a whole number.
kappa: The shape of the Weibull distribution if kappa!=1. Is a numeric vector of length 1.
maxNumberOfIterations: The number of simulation iterations. Is a numeric vector of length 1 containing a whole number.
maxNumberOfSubjects: The maximum number of subjects for power calculations. Is a numeric vector.
maxNumberOfSubjectsPerStage: Determines the maximum number of subjects per stage for data-driven sample size recalculation. For two treatment arms, is the number of subjects for both treatment arms. For multi-arm designs, is the minimum number of subjects per selected active arm. Is a numeric vector of length kMax containing whole numbers.
minNumberOfSubjectsPerStage: Determines the minimum number of subjects per stage for data-driven sample size recalculation. For two treatment arms, is the number of subjects for both treatment arms. For multi-arm designs, is the minimum number of subjects per selected active arm. Is a numeric vector of length kMax containing whole numbers.
numberOfPopulations: The number of populations in an enrichment design. Is a numeric matrix.
plannedSubjects: Determines 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.
populations: The number of populations in an enrichment design. Is a numeric vector of length 1 containing a whole number.
populationEventsPerStage: The cumulative number of events per stage Is a numeric matrix.
rejectAtLeastOne: The probability to reject at least one of the (multiple) hypotheses. Is a numeric vector.
rejectedPopulationsPerStage: The simulated number of rejected populations per stage.
rValue: Needs to be specified if typeOfSelection = "rBest". Is a numeric vector of length 1.
seed: The seed used for random number generation. Is a numeric vector of length 1.
selectedPopulations: The selected populations in enrichment designs.
selectPopulationsFunction: An optional function that can be entered to define the way of how populations are selected.
singleNumberOfEventsPerStage: Deprecated: use singleEventsPerArmAndStage or singleEventsPerSubsetAndStage instead
stratifiedAnalysis: For enrichment designs, typically a stratified analysis should be chosen. When testing means and rates, a non-stratified analysis can be performed on overall data. For survival data, only a stratified analysis is possible. Is a logical vector of length 1.
studyDuration: The study duration for specified effect size. Is a positive numeric vector.
successCriterion: Defines 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 character vector of length 1.
successPerStage: The simulated success probabilities per stage where success is defined by user. Is a numeric matrix.
thetaH1: The assumed effect under the alternative hypothesis. For survival designs, refers to the hazard ratio. Is a numeric vector.
threshold: The 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.
typeOfSelection: The way the treatment arms or populations are selected at interim. Is a character vector of length 1.