cumulative_plot: Plotting the cumulated components of win odds

In maraca: The Maraca Plot: Visualizing Hierarchical Composite Endpoints

Plotting the cumulated components of win odds

Description

Generic function to create a plot showing the components used in calculating win odds (wins and ties) cumulated for all outcomes for a hierarchical endpoint. Implemented for objects of type 'maraca' and 'adhce'.

Usage

cumulative_plot(x, ...)

dustin(x, ...)

dustin_plot(x, ...)

## Default S3 method:
cumulative_plot(x, ...)

## S3 method for class 'maraca'
cumulative_plot(
  x,
  theme = "maraca",
  include = c("win odds", "win ratio"),
  reverse = FALSE,
  ...
)

## S3 method for class 'adhce'
cumulative_plot(
  x,
  step_outcomes = NULL,
  last_outcome = "C",
  arm_levels = c(active = "A", control = "P"),
  theme = "maraca",
  include = c("win odds", "win ratio"),
  reverse = FALSE,
  lowerBetter = FALSE,
  ...
)

Arguments

x	an object of S3 class 'maraca' or 'adhce'.
...	not used
theme	Choose theme to style the plot. The default theme is "maraca". Options are "maraca", "color1", "color2" and none". For more details, check the vignette called "Maraca Plots - Plotting win odds".
include	Vector or single string indicating which statistics to include in the right hand side plot. Acceptable values are "win odds" and/or "win ratio". Default is c("win odds", "win ratio").
reverse	Flag indicating if the cumulated outcomes should be displayed in order from top to bottom (FALSE, the default) or in reverse (TRUE).
step_outcomes	A vector of strings containing the outcome labels for all outcomes displayed as part of the step function on the left side of the plot. The order is kept for the plot. By default (when set to NULL) this is automatically updated by taking the non-continuous outcomes from the GROUP variable in alphabetical order.
last_outcome	A single string containing the last outcome label displayed on the right side of the plot. Default value "C".
arm_levels	A named vector of exactly two strings, mapping the values used for the active and control arms to the values used in the data. The names must be "active" and "control" in this order. Note that this parameter only need to be specified if you have labels different from "active" and "control".
lowerBetter	Flag for the final outcome variable, indicating if lower values are considered better/advantageous. This flag is need to make sure the win odds are calculated correctly. Default value is FALSE, meaning higher values are considered advantageous.

Details

Note that for this plot, if applying to a maraca object, in the original maraca() function run the argument "compute_win_odds" has to be set to TRUE.

Check the vignette "Maraca Plots - Plotting win odds" for more details.

Value

Cumulative plot as a patchwork list. Individual plots can be accessed like list items (plot[[1]] and plot[[2]]).

Examples

data(hce_scenario_a)

maraca_dat <- maraca(data = hce_scenario_a,
                     step_outcomes = c("Outcome I", "Outcome II",
                                      "Outcome III", "Outcome IV"),
                     last_outcome = "Continuous outcome",
                     fixed_followup_days = 3 * 365,
                     column_names = c(outcome = "GROUP",
                                      arm = "TRTP",
                                      value = "AVAL0"),
                     arm_levels = c(active = "Active",
                                    control = "Control"),
                     compute_win_odds = TRUE
                     )

cumulative_plot(maraca_dat)

Rates_A <- c(1.72, 1.74, 0.58, 1.5, 1)
Rates_P <- c(2.47, 2.24, 2.9, 4, 6)
hce_dat <- hce::simHCE(n = 2500, TTE_A = Rates_A, TTE_P = Rates_P,
             CM_A = -3, CM_P = -6, CSD_A = 16, CSD_P = 15, fixedfy = 3,
             seed = 31337)

cumulative_plot(hce_dat)

maraca documentation built on Nov. 21, 2025, 1:07 a.m.