summary.simulab_sim: Summarize simulated variables

View source: R/result.R

summary.simulab_simR Documentation

Summarize simulated variables

Description

Summarizes the primary data only; the other components are not included.

Usage

## S3 method for class 'simulab_sim'
summary(object, ...)

Arguments

object

A simulab_sim object.

...

Reserved for future methods.

Value

A base data.frame with one row per column of the primary data and the columns variable, class, observations, missing, unique, mean, sd, minimum and maximum. The last four are NA for non-numeric columns.

Examples

result <- simulate_ttest(n_a = 30, n_b = 30, mean_a = 0, mean_b = 0.5, seed = 1)
summary(result)

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