Skip to contents

Draws synthetic mutation counts from a dictionary and an exposure profile. The multinomial arm conserves the target burden exactly per sample; the poisson/nb arms draw per channel (the NB arm introduces Jiang-style overdispersion, Var = mu + mu^2/kappa).

Usage

ms_simulate(
  signatures,
  exposures,
  arm = "multinomial",
  size = 8,
  burden = 1000,
  seed = 1
)

Arguments

signatures

An m x k numeric matrix in a supported canonical channel order (SBS96 or DBS78), or an [MsSignature].

exposures

A k x n matrix; columns summing to 1 (or near it) are read as shares and scaled to `burden`, larger columns as count-scale activities (the target is then the column sums).

arm

"multinomial" (exactly N per sample), "poisson", or "nb".

size

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

burden

Target per-sample mutation total for share exposures.

seed

Single non-negative finite seed.

Value

An [MsCatalog] with the draw recorded in provenance.