simulate_clusters: Simulate Gaussian clusters

In simulab: Simulates a Wide Variety of Data Shapes, Sizes and Distributions

Simulate Gaussian clusters

Description

Simulate Gaussian clusters

Usage

simulate_clusters(
  n,
  centers,
  sds = 1,
  proportions = NULL,
  labels = NULL,
  seed = NULL,
  batch = NULL
)

Arguments

n	Sample size.
centers	Matrix with one row per cluster and one column per variable, or a tidy data frame with columns cluster, variable and center.
sds	Scalar, per-variable vector, cluster-by-variable matrix, or a tidy data frame with columns cluster, variable and sd.
proportions	Optional cluster proportions.
labels	Optional cluster labels.
seed	Optional random seed.
batch	Optional single positive whole number. When given, the simulator runs batch times and returns a plain list of batch results, each exactly what the same call without batch returns. With a seed, every dataset gets its own seed drawn from seed, so the whole batch is reproducible; without one the datasets are consecutive draws from the session's random-number stream. The default NULL returns a single result.

Value

A simulab_sim base data.frame with one row per observation and columns id, cluster (the true membership label) and one column per variable. One tidy table comes from as.data.frame(): what = "parameters" has one row per cluster-variable combination with columns cluster, variable, center, sd and proportion.

Examples

# `centers` is one row per cluster and one column per variable.
result <- simulate_clusters(
  n = 150,
  centers = matrix(c(0, 0, 4, 4, 0, 4), nrow = 3, byrow = TRUE),
  sds = 1,
  seed = 1
)
head(result)
as.data.frame(result, what = "parameters")

simulab documentation built on Oct. 15, 2026, 5:08 p.m.