summary.simData: Summary method for simData objects

View source: R/summary.simData.R

summary.simDataR Documentation

Summary method for simData objects

Description

Provides a summary of the simulated meta-analysis dataset using the known simulation parameters.

Usage

## S3 method for class 'simData'
summary(object, digits = 3, ...)

Arguments

object

A simData object created by simData().

digits

The number of significant digits printed. The default value is 3.

...

Additional arguments (currently not used).

Value

A formatted summary of the meta-analysis simulation.


jarbes documentation built on June 28, 2025, 1:07 a.m.