rpact-com / rpact

rpact: Confirmatory Adaptive Clinical Trial Design and Analysis
https://rpact-com.github.io/rpact/
23 stars 5 forks source link

Inconsistent naming of variables: Single and cumulative events per stage #21

Closed fpahlke closed 8 months ago

fpahlke commented 8 months ago

Current Situation:

TrialDesignPlanSurvival (getSampleSizeSurvival / getPowerSurvival)

SimulationResultsSurvival (getSimulationSurvival)

SimulationResults[MultiArm/Enrichment]Survival (getSimulationMultiArmSurvival / getSimulationEnrichmentSurvival)

The ideal change would be as follows:

TrialDesignPlanSurvival (getSampleSizeSurvival / getPowerSurvival)

SimulationResultsSurvival (getSimulationSurvival)

SimulationResults[MultiArm/Enrichment]Survival (getSimulationMultiArmSurvival / getSimulationEnrichmentSurvival)

Issue

Conflicts/Solution Proposals:

TrialDesignPlanSurvival (getSampleSizeSurvival / getPowerSurvival)

SimulationResultsSurvival (getSimulationSurvival)

SimulationResults[MultiArm/Enrichment]Survival (getSimulationMultiArmSurvival / getSimulationEnrichmentSurvival)

In the aggregated simulation results, there are also

The names should be changed to "Observed events per stage"

To implement a consistent solution that is still runnable with existing scripts, it would be best to find a new name for "eventsPerStage", something like "singleEventsPerStage". To ensure a clear distinction from "singleNumberOfEventsPerStage", this variable should be renamed to "singleEventsPerStagePerArm".

fpahlke commented 8 months ago

We optimized the inconsistent naming of variables and class fields as follows: