SummarySampleSetup-class: Class "SummarySampleSetup"

Description Objects from the Class Slots Accessor methods Methods UML class diagram Note Author(s) See Also Examples

Description

Class containing a summary of set up samples.

Objects from the Class

Objects can be created by calls of the form new("SummarySampleSetup", ...) or SummarySampleSetup(...).

However, objects are expected to be created by the summary method for class "SampleSetup", these constructor functions are not supposed to be called by the user.

Slots

size:

Object of class "numeric" giving the size of each of the set up samples.

Accessor methods

getSize

signature(x = "SummarySampleSetup"): get slot size.

Methods

show

signature(object = "SummarySampleSetup"): print a summary of set up samples on the R console.

UML class diagram

A slightly simplified UML class diagram of the framework can be found in Figure 1 of the package vignette An Object-Oriented Framework for Statistical Simulation: The R Package simFrame. Use vignette("simFrame-intro") to view this vignette.

Note

There are no mutator methods available since the slots are not supposed to be changed by the user.

Author(s)

Andreas Alfons

See Also

"SampleSetup", summary

Examples

1
showClass("SummarySampleSetup")

simFrame documentation built on Oct. 14, 2021, 5:24 p.m.