simFrame (version 0.5.4)

head-methods: Methods for returning the first parts of an object

Description

Return the first parts of an object.

Usage

# S4 method for SampleSetup
head(x, k = 6, n = 6, …)
# S4 method for SimControl
head(x)
# S4 method for SimResults
head(x, …)
# S4 method for Strata
head(x, …)
# S4 method for VirtualContControl
head(x)
# S4 method for VirtualDataControl
head(x)
# S4 method for VirtualNAControl
head(x)
# S4 method for VirtualSampleControl
head(x)

Arguments

x

an object.

k

for objects of class "SampleSetup", the number of set up samples to be kept in the resulting object.

n

for objects of class "SampleSetup", the number of indices to be kept in each of the set up samples in the resulting object.

…

additional arguments to be passed down to methods.

Value

An object of the same class as x, but in general smaller. See the “Methods” section below for details.

Methods

signature(x = "SampleSetup")

returns the first parts of set up samples. The first n indices of each of the first k set up samples are kept.

signature(x = "SimControl")

currently returns the object itself.

signature(x = "SimResults")

returns the first parts of simulation results. The method of head for the data.frame in slot values is thereby called.

signature(x = "Strata")

returns the first parts of strata information. The method of head for the vector in slot values is thereby called and the slots split and size are adapted accordingly.

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

head, "'>SampleSetup", "'>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)
# get the first 10 indices of each of the first 5 samples
head(set, k = 5, n = 10)

## class "Strata"
# set up samples using group sampling
strata <- stratify(eusilcP, "region")
summary(strata)
# get strata information for the first 10 observations
head(strata, 10)
# }