Skip to contents

An [MsSignature] holds de-novo extracted signatures and their exposures plus the method evidence (stability, K selection), the engine name, the seed and a **snapshot summary** of the source catalog. The summary carries dimensions, the channel-table hash and the build – never the catalog itself (A5). Violations raise `msuiter_error_signature`.

Usage

MsSignature(
  signatures = NULL,
  exposures = NULL,
  stability = list(),
  k_evidence = NULL,
  engine = character(0),
  seed = integer(0),
  catalog_summary = list()
)

Arguments

signatures

numeric matrix (channels x signatures) with rownames = channel labels, colnames = signature labels.

exposures

numeric matrix (signatures x samples) with rownames identical to `colnames(signatures)` and colnames = sample labels.

stability

named list of stability evidence (default empty).

k_evidence

data.frame of K-selection evidence with a `k` column when non-empty (default empty).

engine

single non-empty string naming the engine used.

seed

single finite number: the seed behind the result.

catalog_summary

snapshot summary as built by [msuiter_catalog_summary()]: list with fields `n_channels`, `n_samples`, `channel_name`, `channel_hash`, `build`.