BasicVector-class: Class "BasicVector"

In aalfons/simFrame: Simulation Framework

Description

Virtual class used internally for convenience.

Objects from the Class

A virtual Class: No objects may be created from it.

Extends

Class "OptBasicVector", directly.

Methods

getStrataLegend

signature(x = "data.frame", design = "BasicVector"): get a data.frame describing the strata.

getStrataSplit

signature(x = "data.frame", design = "BasicVector"): get a list in which each element contains the indices of the observations belonging to the corresponding stratum.

getStrataTable

signature(x = "data.frame", design = "BasicVector"): get a data.frame describing the strata and containing the stratum sizes.

getStratumSizes

signature(x = "data.frame", design = "BasicVector"): get the stratum sizes.

getStratumValues

signature(x = "data.frame", design = "BasicVector", split = "missing"): get the stratum number for each observation.

getStratumValues

signature(x = "data.frame", design = "BasicVector", split = "list"): get the stratum number for each observation.

simApply

signature(x = "data.frame", design = "BasicVector", fun = "function"): apply a function to subsets.

simSapply

signature(x = "data.frame", design = "BasicVector", fun = "function"): apply a function to subsets.

stratify

signature(x = "data.frame", design = "BasicVector"): stratify data.

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.

Author(s)

Andreas Alfons

Examples

showClass("BasicVector")

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