summary,Simulation-method {dsims}

summary

Description

Provides a summary of the simulation results.

Usage

## S4 method for signature 'Simulation'
summary(object, description.summary = TRUE, use.max.reps = FALSE, ...)

Arguments

object

object of class Simulation

description.summary

logical indicating whether an explanation of the summary should be displayed

use.max.reps

by default this is FALSE meaning that only simulation repetitions where all models converged for that data set are included. By setting this to TRUE any repetition where one or more models converged will be included in the summary results.

...

no additional arguments currently implemented

Value

Object of class Simulation.Summary