Description Objects from the Class Slots Accessor methods Methods UML class diagram Note Author(s) References See Also Examples
Class for set up samples.
Objects can be created by calls of the form new("SampleSetup", ...)
or
SampleSetup(...)
.
However, objects are expected to be created by the function setup
or clusterSetup
, these constructor functions are not supposed to
be called by the user.
indices
:Object of class "list"
; each list element
contains the indices of the sampled observations.
prob
:Object of class "numeric"
giving the
inclusion probabilities.
control
:Object of class "VirtualSampleControl"
; the
control object used to set up the samples.
seed
:Object of class "list"
containing the seeds of
the random number generator before and after setting up the samples,
respectively (for replication purposes).
call
:Object of class "SimCall"
; the function call
used to set up the samples, or NULL
.
getIndices
signature(x = "SampleSetup")
: get slot
indices
.
getProb
signature(x = "SampleSetup")
: get slot
prob
.
getControl
signature(x = "SampleSetup")
: get slot
control
.
getSeed
signature(x = "SampleSetup")
: get slot
seed
.
getCall
signature(x = "SampleSetup")
: get slot
call
.
clusterRunSimulation
signature(cl = "ANY",
x = "data.frame", setup = "SampleSetup", nrep = "missing",
control = "SimControl")
: run a simulation experiment on a cluster.
draw
signature(x = "data.frame",
setup = "SampleSetup")
: draw a sample.
head
signature(x = "SampleSetup")
: returns the first
parts of set up samples.
length
signature(x = "SampleSetup")
: get the number of
set up samples.
runSimulation
signature(x = "data.frame",
setup = "SampleSetup", nrep = "missing", control = "SimControl")
: run a
simulation experiment.
show
signature(object = "SampleSetup")
: print set up
samples on the R console.
summary
signature(object = "SampleSetup")
: produce a
summary of set up samples.
tail
signature(x = "SampleSetup")
: returns the last
parts of set up samples.
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.
There are no mutator methods available since the slots are not supposed to be changed by the user.
Furthermore, the slot seed
was added in version 0.2, and the slot
control
was added in version 0.3. Since the control object used to
set up the samples is now stored, the redundant slots design
,
grouping
, collect
and fun
were removed. This has been
done as preparation for additional control classes for sampling, which will
be introduced in future versions.
Andreas Alfons
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.
"SampleControl"
, "TwoStageControl"
,
"VirtualSampleControl"
,
setup
, draw
1 | showClass("SampleSetup")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.