summary.simss: Summary for Simulation Results

View source: R/summary.simss.R

summary.simssR Documentation

Summary for Simulation Results

Description

Generates a summary of the simulation results, including per-arm and total sample sizes. The printed summary also states the equivalence null and alternative hypotheses for the selected outcome and design.

Usage

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

Arguments

object

An object of class "simss" returned by a sampleSize function.

...

Additional arguments (currently unused).

Value

Invisibly, a data frame containing the estimated sample size for each arm (or sequence), plus the total sample size. The printed report also includes the design, estimand, equivalence margins, target power, achieved power, and Monte Carlo interval. Count-outcome results use this same report and retain their count-specific fields in the returned object.

Author(s)

Johanna Muñoz johanna.munoz@fromdatatowisdom.com

Examples

## Not run: 
res <- sampleSize(mu_list = list(T = c(y1 = 1), R = c(y1 = 1)),
                  sigma_list = list(T = c(y1 = .2), R = c(y1 = .2)),
                  list_comparator = list(c("T", "R")),
                  list_lequi.tol = list(c(y1 = .8)),
                  list_uequi.tol = list(c(y1 = 1.25)),
                  ctype = "ROM", distribution = "lnorm", nsim = 10,
                  lower = 2, upper = 4)
summary(res)

## End(Not run)

SimTOST documentation built on Oct. 9, 2026, 5:07 p.m.