simFrame (version 0.5.0)

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

Description

Produce a summary an object.

Usage

## S3 method for class 'SampleSetup':
summary(object)
## S3 method for class 'SimControl':
summary(object)
## S3 method for class 'SimResults':
summary(object, \dots)
## S3 method for class 'Strata':
summary(object)
## S3 method for class 'VirtualContControl':
summary(object)
## S3 method for class 'VirtualDataControl':
summary(object)
## S3 method for class 'VirtualNAControl':
summary(object)
## S3 method for class '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.

References

Alfons, A., Templ, M. and Filzmoser, P. (2010) An Object-Oriented Framework for Statistical Simulation: The RPackage simFrame. Journal of Statistical Software, 37(3), 1--36. URL http://www.jstatsoft.org/v37/i03/.

See Also

summary, "SampleSetup", "SummarySampleSetup", "SimResults", "Strata"

Examples

## 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)