summary.lsasimcluster: Summarizes clusters

In lsasim: Functions to Facilitate the Simulation of Large Scale Assessment Data

Summarizes clusters

Description

Takes the output of 'cluster_gen' and creates summary statistics of the questionnaire variables

Usage

## S3 method for class 'lsasimcluster'
summary(
  object,
  digits = 4,
  print = "partial",
  print_hetcor = TRUE,
  force_matrix = FALSE,
  ...
)

Arguments

object	output of 'cluster_gen'
digits	loosely controls the number of digits (significant or not) in the output (for 'print = TRUE')
print	"all" will pretty-print a summary of statistics, "partial" will only print cluster-level sumamrizes; "none" outputs statistics as a list
print_hetcor	if 'TRUE' (default), prints the heterogeneous correlation matrix
force_matrix	if 'TRUE', prints the heterogeneous correlation matrix even if warnings are generated
...	additional arguments (unused; added for compatibility with generic)

Value

list of summaries

Note

Setting 'print="none"' allows for saving the results as an R object (list). Otherwise, the results will be simply printed and not saveable.

Changing 'digits' may yield unexpected results for the estimates of continuous variables, given how most of them are printed using the number of significant digits (for more information, see 'help("summary")').

Please note that datasets containing large values for the coefficient of variation (sigma / mu) should yield imprecise results.

See Also

anova.lsasimcluster

Examples

n <- c(3, 30)
cls <- cluster_gen(n, n_X = 3, n_W = 5)
summary(cls)
summary(cls, print="none") # allows saving results

lsasim documentation built on Aug. 22, 2023, 5:09 p.m.