Skip to content

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

Closed
@fpahlke

Description

@fpahlke

Current Situation:

TrialDesignPlanSurvival (getSampleSizeSurvival / getPowerSurvival)

  • eventsPerStage: Cumulative events per stage

SimulationResultsSurvival (getSimulationSurvival)

  • eventsPerStage: Number of events per stage
  • overallEventsPerStage: Cumulative events per stage

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

  • eventsPerStage: Cumulative events per stage {"per treatment arm compared to control"}
  • singleNumberOfEventsPerStage: Single number of events {"per treatment arm"}

The ideal change would be as follows:

TrialDesignPlanSurvival (getSampleSizeSurvival / getPowerSurvival)

  • eventsPerStage: Number of events per stage
  • cumulativeEventsPerStage: Cumulative events per stage

SimulationResultsSurvival (getSimulationSurvival)

  • eventsPerStage: Number of events per stage
  • cumulativeEventsPerStage: Cumulative events per stage

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

  • eventsPerStage: Number of events per stage {"per treatment arm compared to control"}
  • cumulativeEventsPerStage: Cumulative events per stage {"per treatment arm compared to control"}
  • singleNumberOfEventsPerStage: Single number of events {"per treatment arm"}

Issue

  • Users already pointed out this problem with the inconsistent variable names in 2019/2020
  • The R scripts of the "rpact Power Users" are now based on these inconsistent names

Conflicts/Solution Proposals:

TrialDesignPlanSurvival (getSampleSizeSurvival / getPowerSurvival)

  • eventsPerStage: Cumulative events per stage (unfortunately, this name is taken and cannot stand for "Number of events per stage")
  • cumulativeEventsPerStage: Cumulative events per stage

SimulationResultsSurvival (getSimulationSurvival)

  • eventsPerStage: Number of events per stage
  • cumulativeEventsPerStage: Cumulative events per stage
  • overallEventsPerStage: Cumulative events per stage (must remain as a duplicate and be marked as "deprecated")

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

  • eventsPerStage: Cumulative events per stage (unfortunately, this name is taken and cannot stand for "Number of events per stage")
  • cumulativeEventsPerStage: Cumulative events per stage
  • singleNumberOfEventsPerStage: Single number of events {"per treatment arm"}

In the aggregated simulation results, there are also

  • eventsPerStage1 = "Observed events by stage (1)"
  • eventsPerStage2 = "Observed events by stage (2)"

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".

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions