tail-methods: Methods for returning the last parts of an object

Description Usage Arguments Value Methods Author(s) References See Also Examples

Description

Return the last parts of an object.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
## S4 method for signature 'SampleSetup'
tail(x, k = 6, n = 6, ...)

## S4 method for signature 'SimControl'
tail(x)

## S4 method for signature 'SimResults'
tail(x, ...)

## S4 method for signature 'Strata'
tail(x, ...)

## S4 method for signature 'VirtualContControl'
tail(x)

## S4 method for signature 'VirtualDataControl'
tail(x)

## S4 method for signature 'VirtualNAControl'
tail(x)

## S4 method for signature 'VirtualSampleControl'
tail(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 last parts of set up samples. The last n indices of each of the last k set up samples are kept.

signature(x = "SimControl")

currently returns the object itself.

signature(x = "SimResults")

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

signature(x = "Strata")

returns the last parts of strata information. The method of tail 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.

Author(s)

Andreas Alfons

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. doi: 10.18637/jss.v037.i03.

See Also

tail, "SampleSetup", "SimResults", "Strata"

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## 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 last 10 indices of each of the last 5 samples
tail(set, k = 5, n = 10)

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

aalfons/simFrame documentation built on Nov. 27, 2021, 7:51 a.m.