Skip to contents

Builds a validated transport configuration that can be passed to [dkge_pipeline()] or transport utilities. The helper enforces basic argument checks and provides sensible defaults for Sinkhorn-based mapping.

Usage

dkge_transport_spec(
  centroids,
  sizes = NULL,
  medoid = 1L,
  method = c("sinkhorn", "sinkhorn_cpp", "knn"),
  mapper = NULL,
  epsilon = 0.05,
  max_iter = 200L,
  tol = 1e-06,
  lambda_emb = 1,
  lambda_spa = 0.5,
  sigma_mm = 15,
  lambda_size = 0,
  ...
)

Arguments

centroids

List of subject-specific centroid matrices (P_s x d).

sizes

Optional list of cluster sizes (one numeric vector per subject).

medoid

Integer index of the medoid subject (default 1).

method

Mapper backend. Default "sinkhorn".

mapper

Optional prefit mapper specification (advanced use).

epsilon

Sinkhorn entropic regularisation parameter.

max_iter

Maximum Sinkhorn iterations.

tol

Convergence tolerance for Sinkhorn scaling.

lambda_emb

Weight on embedding distance in the cost matrix.

lambda_spa

Weight on spatial distance in the cost matrix.

sigma_mm

Spatial scale (in millimetres) used when spatial coordinates are available.

lambda_size

Weight on size regularisation between clusters.

...

Additional fields stored on the spec (e.g., precomputed loadings or betas).

Value

Object with class `dkge_transport_spec`.

Examples

transport <- dkge_transport_spec(centroids = list(matrix(runif(12), 4, 3)))