R-Package "distrSim"

Version: 2.8.5
Release Date: 2024-08-29
Authors: Peter Ruckdeschel, Matthias Kohl, Thomas Stabla, Florian Camphausen
Required R-Version:

>=3.4 for version 2.8.0
>=2.14.0 for version 2.5.2
>=2.6.0 for version 2.1,
>=2.2.0 for versions 1.6-2.0

Dependencies: requires package "setRNG" version >= 2006.2-1 by Paul Gilbert available from CRAN;
as well as package "distr" version >= 1.9 by the authors of this package and "startupmsg" by Peter Ruckdeschel
also available from CRAN; it also suggests package "distrEx" version >= 0.4-4 by the authors of this package;

What is "distrSim" meant for?

The aim of package "distrSim" is to provide a conceptual treatment of simulations of random variables (r.v.'s) by means of distribution classes from our package "distr" .
These are grouped together with ``real world'' data as subclasses of the mother class "Dataclass" which both may serve as input data for statistical procedures.
This mother class has slots filename (where the data is to be stored), Data (the data), samplesize (the size of the sample), obsDim (the observation dimension), and runs
(number of repetitions of the experiment).
For simulations in the proper sense there is class "Simulation" is introduced with additional slots seed (for the random number generator to make the simulations reproducible;
thanks to Paul Gilbert's setRNG), distribution (the distribution from which to sample, of class Distribution from package "distr")
For studies in Robust Statistics, we also derive a class "Contsimulation" is introduced with additional slots Data.id (the data from the ideal situation),
Data.c (the data from the contaminating situation), ind (a indicator telling the ideal from the contaminated observations), rate (the probability for an outlier to occur),
distribution.id and distribution.c (the ideal and contaminating distributions from which to sample; of class Distribution from package "distr")

For these classes special plot, print, show and summary methods are available; all slots are accessed/modified by accessor/replacement functions.
As generally, you are not interested in the figures of the simulations, these are not saved by default, -- only the seed to reproduce them is retained.
To (re)fill the data slot(s) you use the method simulate.

Manual

for version prior to 1.8, a somewhat more detailed manual to this package in pdf-format is available here;
from version 1.8 on, we have converted this manual into a common vignette to packages distr, distrEx, distrSim, distrTEst, distrMod, distrTeach,
which is available in the mere documentation package distrDoc. To use it you may type

        require("distrDoc"); V<-vignette("distr"); print(V); edit(V)

License

This software is distributed under the terms of the GNU GENERAL
PUBLIC LICENSE LGPL v3, confer http://www.gnu.org/licenses/lgpl-3.0.html

Download

Windows

for version >= 2.0 use

install.packages("distrSim", repos = "R-Forge.R-project.org")

as Win-Zip-File for R >=2.2.0 (Version 1.9)
as Win-Zip-File for R >=2.2.0 (Version 1.8)
as Win-Zip-File for R >=2.2.0 (Version 1.7)
as Win-Zip-File for R >=2.2.0 (Version 1.6)

to be installed by
- the R-gui File picker [Packages ->Install package(s) from local zip-files...] or
- ```
install.packages("distrSim", <path to the file distr.zip in your File system>, NULL)
```
to be removed by
```
remove.packages("distrSim")
```

to be used by

library("distrSim")

require("distrSim")

Linux

for version >= 2.0 use

install.packages("distrSim", repos = "R-Forge.R-project.org")

as Linux-tar-gz-File for R >=2.2.0 (Version 1.9)
as Linux-tar-gz-File for R >=2.2.0 (Version 1.8)
as Linux-tar-gz-File for R >=2.2.0 (Version 1.7)
as Linux-tar-gz-File for R >=2.2.0 (Version 1.6)

to be installed by

R CMD INSTALL distrSim_1.x.tar.gz

to be removed by
```
R CMD REMOVE distrSim
```
to be used as under Windows

Sources

included into the .tar.gz.file
for R version 1.7 see web-page to "distr"

Demos

also see demo("distr") and demo("distrSim") --- after installation of "distr"/"distrSim"

A simulation example:
Simulate.R

Version history:

Changes from distr 1.5 to distrSim 1.6

the signature of simulate has been changed in order to stay compatible with the generic simulate from package stats
the user should not notice any difference

Changes from 1.6 to 1.7

imports setRNG namespace (introduced from version 2006.2-1 on)

Changes from 1.7 to 1.8

global options for printing and plotting are now managed distrSimoptions(), getdistrSimOption()
generic savedata now has a ... argument
Attention: From version 1.8 of this package on, the format how data / simulations are stored is changed:

for dealing with multivariate distributions, regression distributions and (later) time series distributions,
we have switched to the common array format:
```
	samplesize x obsDim x runs 
```
for saved objects from earlier versions, we provide the functions
isOldVersion and conv2NewVersion to check whether the object was
generated by an older version of this package and to convert
such an object to the new format, respectively
in particular: new slots version, obsDim, and name for class "Dataclass" and subclasses

Changes from 1.8 to 1.9

cleaning up of source files:

adapted the naming of the .R files to the use of the (later written) extension packages
(and according to http://tolstoy.newcastle.edu.au/R/help/06/03/22558.html)

checked all source file to adhere to the 80char's-per-line rule

mentioned in package-help: startup messages may now also be suppressed by
suppressPackageStartupMessages() (from package 'base')
Version-management

moved generics to isOldVersion(), conv2NewVersion() from package 'distrSim' to package 'distr'
replaced isOldVersion() method for signature "Dataclass" by method for signature "ANY" from package 'distr'

Changes from 1.9 to 2.0

new class "SeqDataFrames" for a sequence of data frames with common column structure

Changes from 2.0 to 2.1

Rd-style:

several buglets detected with the fuzzier checking mechanism

cf [Rd] More intensive checking of R help files, Prof Brian Ripley, 09.01.2009 10:25)
[Rd] Warning: missing text for item ... in \describe? , Prof Brian Ripley

S4 issues: JMC has changed the way matrices and arrays are treated as S4 classes
plotting modified plot methods to better digest "..." (argument "add" is TRUE by default now)
moved license to LGPL-3