simFrame (version 0.5.4)

summary-methods: Methods for producing a summary of an object

Description

Produce a summary an object.

Usage

# S4 method for SampleSetup
summary(object)
# S4 method for SimControl
summary(object)
# S4 method for SimResults
summary(object, …)
# S4 method for Strata
summary(object)
# S4 method for VirtualContControl
summary(object)
# S4 method for VirtualDataControl
summary(object)
# S4 method for VirtualNAControl
summary(object)
# S4 method for VirtualSampleControl
summary(object)

Arguments

object

an object.

…

additional arguments to be passed down to methods.

Value

The form of the resulting object depends on the class of the argument object. See the “Methods” section below for details.

Methods

signature(x = "SampleSetup")

returns an object of class SummarySampleSetup, which contains information on the size of each of the set up samples.

signature(x = "SimControl")

currently returns the object itself.

signature(x = "SimResults")

produces a summary of the simulation results by calling the method of summary for the data.frame in slot values.

signature(x = "Strata")

returns a data.frame containing the size of each stratum.

signature(x = "VirtualContControl")

currently returns the object itself.

signature(x = "VirtualDataControl")

currently returns the object itself.

signature(x = "VirtualNAControl")

currently returns the object itself.

signature(x = "VirtualSampleControl")

currently returns the object itself.

References

Alfons, A., Templ, M. and Filzmoser, P. (2010) An Object-Oriented Framework for Statistical Simulation: The R Package simFrame. Journal of Statistical Software, 37(3), 1--36. 10.18637/jss.v037.i03.

See Also

summary, "'>SampleSetup", "'>SummarySampleSetup", "'>SimResults", "'>Strata"

Examples

# NOT RUN {
## load data
data(eusilcP)

## class "SampleSetup"
# set up samples using group sampling
set <- setup(eusilcP, grouping = "hid", size = 1000, k = 50)
summary(set)

## class "Strata"
# set up samples using group sampling
strata <- stratify(eusilcP, "region")
summary(strata)
# }