Simulation-class {distrSim}R Documentation

Class "Simulation"

Description

In an object of type Simulation data can be simulated in any distribution and size.

Objects from the Class

Objects can be created by calls of the form Simulation(filename, samplesize, runs, seed, distribution) (observation dimension is deduced from slot distribution). A Simulation-object includes a filename, a name for the simulation, the number of runs, the size of the sample, the seed and the distribution of the random numbers. The slot Data stays empty until the method simulate has been used.

Slots

seed:
Object of class "list": the seed the simulation has been generated with
distribution:
Object of class "UnivariateDistribution": the distribution of the random numbers
filename:
Object of class "character": the filename the simulation shall be saved
name:
Object of class "character": a name for the Simulation
Data:
Object of class "ArrayorNULLorVector": the simulated data
samplesize:
Object of class "numeric": the size of the sample
obsDim:
Object of class "numeric": the dimension of the observations of the data
runs:
Object of class "numeric": the number of runs of the data
version:
Object of class "character": the version of this package, under which this object was generated

Extends

Class "Dataclass", directly.

Methods

Data
signature(object = "Simulation"): returns the simulated data.
Data<-
signature(object = "Simulation"): ERROR: A modification of simulated data is not allowed.
filename
signature(object = "Simulation"): returns the the filename
filename<-
signature(object = "Simulation"): changes the the filename
name
signature(object = "Simulation"): returns the the name
name<-
signature(object = "Simulation"): changes the the name
distribution
signature(object = "Simulation"): returns the distribution
distribution<-
signature(object = "Simulation"): changes the distribution
seed
signature(object = "Simulation"): returns the seed
seed<-
signature(object = "Simulation"): changes the seed
obsDim
signature(object = "Simulation"): returns the dimension of the observations
getVersion
signature(object = "Simulation"): returns the version of this package, under which this object was generated
runs
signature(object = "Simulation"): returns the number of runs
runs<-
signature(object = "Simulation"): changes the number of runs
samplesize
signature(object = "Simulation"): returns the size of the sample
samplesize<-
signature(object = "Simulation"): changes the size of the sample
savedata
signature(object = "Simulation"): saves the object without the data in the directory of R (After loading the data can be reproduced by using simulate.)
initialize
signature(.Object = "Simulation"): initialize method
plot
signature(x = "Simulation"): produces a plot of the data matrix; for details confer plot-methods
print
signature(x = "Simulation"): returns filename, seed, the observation dimension, the number of runs, the size of the sample, the distribution generating the simulations, and, if from a version > 1.8, also the package version under which the object was generated
show
signature(x = "Simulation"): the same as print.
simulate
signature(x = "Simulation"): generates the random numbers for the simulation
summary
signature(object = "Simulation"): returns filename, seed, number of runs, the size of the sample and a statistical summary for each run

Note

Changing distribution, seed, runs or samplesize deletes possibly simulated data, as it would not fit to the new parameters.

Author(s)

Thomas Stabla statho3@web.de,
Florian Camphausen fcampi@gmx.de,
Peter Ruckdeschel Peter.Ruckdeschel@itwm.fraunhofer.de,
Matthias Kohl Matthias.Kohl@stamats.de

See Also

Dataclass-class Contsimulation-class plot-methods print-methods summary-methods simulate-methods getVersion-methods

Examples

N=Norm() # N is a standard normal distribution.
S=Simulation(filename="xyz",runs=10,samplesize=3,seed=setRNG(),distribution=N)
Data(S) # no data yet
simulate(S)
Data(S) # now there are random numbers
Data(S) # the same data as before because the seed has not changed
seed(S)=setRNG()
simulate(S)
Data(S) # different data
savedata(S) # saves the object in the directory of R...
load("xyz") # loads it again...
Data(S) # ...without the data - use simulate to return it!

[Package distrSim version 2.0.4 Index]