Skip to contents

Construct one benchmark scenario

Source: R/ms-benchmark-driver.R
ms_benchmark_grid.Rd

One calibration-layer scenario: a burden, a sample count, an active signature count, and a generative arm – all fed to [ms_simulate()] against a seeded draw from the bundled COSMIC v3.6 SBS96 dictionary. A grid is a named list of scenarios. Create specs with `ms_benchmark_grid()`, execute with [ms_run_benchmark()], store via [ms_benchmark()] – the trio stays three separate functions by the U-M7-04 ergonomics ruling (no generic merge).

Usage

ms_benchmark_grid(
  name = "scenario",
  n_samples = 20,
  burden = 3000,
  k_active = 3,
  arm = "multinomial",
  size = 8
)

Arguments

name

Unique scenario name.

n_samples

Simulated sample count (>= 4).

burden

Per-sample mutation burden (whole number >= 200).

k_active

Active signature count (2 <= k_active <= 20).

arm

Generative arm for [ms_simulate()]: "multinomial", "poisson" or "nb".

size

NB size kappa (arm = "nb" only).

Value

A validated scenario list.

See also

Other benchmark: ms_benchmark(), ms_run_benchmark()