VirtualSampleControl-class: Class "VirtualSampleControl"

In aalfons/simFrame: Simulation Framework

Description

Virtual superclass for controlling the setup of samples.

Objects from the Class

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

Slots

k:

Object of class "numeric", a single positive integer giving the number of samples to be set up.

Extends

Class "OptSampleControl", directly.

Accessor and mutator methods

getK

signature(x = "VirtualSampleControl"): get slot k.

setK

signature(x = "VirtualSampleControl"): set slot k.

Methods

clusterRunSimulation

signature(cl = "ANY", x = "data.frame", setup = "VirtualSampleControl", nrep = "missing", control = "SimControl"): run a simulation experiment on a cluster.

clusterRunSimulation

signature(cl = "ANY", x = "VirtualDataControl", setup = "VirtualSampleControl", nrep = "numeric", control = "SimControl"): run a simulation experiment on a cluster.

draw

signature(x = "data.frame", setup = "VirtualSampleControl"): draw a sample.

head

signature(x = "VirtualSampleControl"): currently returns the object itself.

length

signature(x = "VirtualSampleControl"): get the number of samples to be set up.

runSimulation

signature(x = "data.frame", setup = "VirtualSampleControl", nrep = "missing", control = "SimControl"): run a simulation experiment.

runSimulation

signature(x = "VirtualDataControl", setup = "VirtualSampleControl", nrep = "numeric", control = "SimControl"): run a simulation experiment.

runSimulation

signature(x = "VirtualDataControl", setup = "VirtualSampleControl", nrep = "missing", control = "SimControl"): run a simulation experiment.

show

signature(object = "VirtualSampleControl"): print the object on the R console.

summary

signature(object = "VirtualSampleControl"): currently returns the object itself.

tail

signature(x = "VirtualSampleControl"): currently returns the object itself.

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

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

"SampleControl", "TwoStageControl", "SampleSetup", setup, draw

Examples

showClass("VirtualSampleControl")

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