Skip to contents

Format Operating Characteristics Results as GT Table

Source: R/oc_analyses_gbsg.R
format_oc_results.Rd

Creates a formatted gt table from simulation operating characteristics results.

Usage

format_oc_results(
  results,
  analyses = NULL,
  metrics = "all",
  digits = 3,
  digits_hr = 3,
  title = "Operating Characteristics Summary",
  subtitle = NULL,
  use_gt = TRUE
)

Arguments

results

data.table or data.frame. Simulation results from run_simulation_analysis or combined results from multiple simulations.

analyses

Character vector. Analysis methods to include. Default: NULL (all analyses in results)

metrics

Character vector. Metrics to display. Options include: "detection", "classification", "hr_estimates", "ahr_estimates", "cde_estimates", "subgroup_size", "all". Default: "all"

digits

Integer. Decimal places for proportions. Default: 3

digits_hr

Integer. Decimal places for hazard ratios. Default: 3

title

Character. Table title. Default: "Operating Characteristics Summary"

subtitle

Character. Table subtitle. Default: NULL

use_gt

Logical. Return gt table if TRUE, data.frame if FALSE. Default: TRUE

Value

A gt table object (if use_gt = TRUE and gt package available) or data.frame

Details

The function summarizes simulation results across multiple metrics:

  • Found: Proportion of simulations finding a subgroup (any.H)

  • Classification: Sen, spec, PPV, NPV

  • HR Estimates: Mean Cox hazard ratios in true (H) and identified (H-hat) subgroups and their complements

  • AHR Estimates: Mean average hazard ratios (from loghr_po) in true and identified subgroups

  • CDE Estimates: Controlled direct effects (from theta_0/theta_1) in true and identified subgroups

  • Subgroup Size: Average, min, max sizes

Column notation aligns with build_estimation_table and Leon et al. (2024): H = true (oracle) subgroup, H-hat = identified subgroup. The asterisk (*) is reserved for bootstrap bias-corrected estimates and is not used in this summary table.