get_arm_simulations: Extract Arm-Level Simulations from Hierarchical Simulations

In crmPack: Object-Oriented Implementation of Dose Escalation Designs

Extract Arm-Level Simulations from Hierarchical Simulations

Description

Rebuilds the simulation object for one hierarchical arm, so that summary calculations can delegate to the existing Simulations or ComboSimulations methods.

Usage

get_arm_simulations(object, arm_name)

Arguments

object	(HierarchicalSimulations) hierarchical simulation results.
arm_name	(string) hierarchical arm name to extract.

Value

A Simulations object for a single-agent arm or a ComboSimulations object for a combination arm.

Examples

arm_data <- Data(
  x = c(10, 20),
  y = c(0L, 1L),
  doseGrid = c(10, 20),
  ID = 1L:2L,
  cohort = 1L:2L
)
hierarchical_sims <- HierarchicalSimulations(
  data = list(HierarchicalData(arm_a = arm_data)),
  doses = list(list(arm_a = 20)),
  samples = list(HierarchicalSamples(
    data = list(alpha0_arm_a = c(-3, -2)),
    options = McmcOptions(burnin = 1, step = 1, samples = 2),
    arm_samples = list(arm_a = c(alpha0 = "alpha0_arm_a"))
  )),
  fit = list(list(arm_a = data.frame(
    middle = c(0.1, 0.3),
    lower = c(0.05, 0.2),
    upper = c(0.2, 0.4)
  ))),
  stop_reasons = list(list(arm_a = "Minimum patients")),
  stop_report = list(list(arm_a = c(`Minimum patients` = TRUE))),
  additional_stats = list(list(arm_a = list())),
  seed = 123L
)

get_arm_simulations(hierarchical_sims, "arm_a")

crmPack documentation built on July 5, 2026, 9:06 a.m.