Package ‘simFrame’ - The Comprehensive R Archive · PDF filesrs Random sampling...
113
Package ‘simFrame’ February 20, 2015 Version 0.5.3 Title Simulation framework Date 2014-03-03 Depends R (>= 2.14.0), Rcpp (>= 0.8.6), lattice, parallel Imports methods, stats4 Suggests laeken, mvtnorm, robCompositions, sampling LinkingTo Rcpp SystemRequirements GNU make Description A general framework for statistical simulation. License GPL (>= 2) LazyLoad yes Author Andreas Alfons [aut, cre] Maintainer Andreas Alfons <[email protected]> NeedsCompilation yes Repository CRAN Date/Publication 2014-03-03 10:43:34 R topics documented: simFrame-package ..................................... 3 accessors .......................................... 5 aggregate-methods ..................................... 12 BasicVector-class ...................................... 14 clusterRunSimulation .................................... 16 clusterSetup ......................................... 20 contaminate ......................................... 23 ContControl ......................................... 25 ContControl-class ...................................... 26 DARContControl-class ................................... 28 DataControl-class ...................................... 30 DCARContControl-class .................................. 32 1
Transcript of Package ‘simFrame’ - The Comprehensive R Archive · PDF filesrs Random sampling...
Package simFrameFebruary 20, 2015
Version 0.5.3Title Simulation frameworkDate 2014-03-03Depends R (>= 2.14.0), Rcpp (>= 0.8.6), lattice, parallelImports methods, stats4Suggests laeken, mvtnorm, robCompositions, samplingLinkingTo RcppSystemRequirements GNU makeDescription A general framework for statistical simulation.License GPL (>= 2)LazyLoad yesAuthor Andreas Alfons [aut, cre]Maintainer Andreas Alfons NeedsCompilation yesRepository CRANDate/Publication 2014-03-03 10:43:34
R topics documented:simFrame-package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3accessors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5aggregate-methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12BasicVector-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14clusterRunSimulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16clusterSetup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20contaminate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23ContControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25ContControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26DARContControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28DataControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30DCARContControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1
2 R topics documented:
draw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34eusilcP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35generate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37head-methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39inclusionProb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41length-methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42NAControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43NumericMatrix-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45OptBasicVector-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46OptCall-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47OptCharacter-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47OptContControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48OptDataControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49OptNAControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49OptNumeric-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50OptSampleControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51plot-methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51runSimulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53SampleControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57SampleSetup-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59sampling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61setNA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65simApply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67simBwplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68SimControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71simDensityplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74SimResults-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77simSample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79simXyplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Strata-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84stratify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85stratify-utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86summary-methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88SummarySampleSetup-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90tail-methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91TwoStageControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93VirtualContControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96VirtualDataControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97VirtualNAControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98VirtualSampleControl-class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Index 102
simFrame-package 3
simFrame-package Simulation framework
Description
A general framework for statistical simulation.
Details
Package: simFrameVersion: 0.5.3Date: 2014-03-03Depends: R (>= 2.14.0), Rcpp (>= 0.8.6), lattice, parallelImports: methods, stats4Suggests: laeken, mvtnorm, robCompositions, samplingLinkingTo: RcppSystemRequirements: GNU makeLicense: GPL (>= 2)LazyLoad: yes
Index:
BasicVector-class Class "BasicVector"ContControl Create contamination control objectsContControl-class Class "ContControl"DARContControl-class Class "DARContControl"DCARContControl-class Class "DCARContControl"DataControl-class Class "DataControl"NAControl-class Class "NAControl"NumericMatrix-class Class "NumericMatrix"OptBasicVector-class Class "OptBasicVector"OptCall-class Class "OptCall"OptCharacter-class Class "OptCharacter"OptContControl-class Class "OptContControl"OptDataControl-class Class "OptDataControl"OptNAControl-class Class "OptNAControl"OptNumeric-class Class "OptNumeric"OptSampleControl-class
Class "OptSampleControl"SampleControl-class Class "SampleControl"SampleSetup-class Class "SampleSetup"SimControl-class Class "SimControl"SimResults-class Class "SimResults"Strata-class Class "Strata"SummarySampleSetup-class
4 simFrame-package
Class "SummarySampleSetup"TwoStageControl-class Class "TwoStageControl"VirtualContControl-class
Class "VirtualContControl"VirtualDataControl-class
Class "VirtualDataControl"VirtualNAControl-class
Class "VirtualNAControl"VirtualSampleControl-class
Class "VirtualSampleControl"aggregate-methods Method for aggregating simulation resultsclusterRunSimulation Run a simulation experiment on a clusterclusterSetup Set up multiple samples on a clustercontaminate Contaminate datadraw Draw a sampleeusilcP Synthetic EU-SILC datagenerate Generate datagetAdd Accessor and mutator functions for objectsgetStrataLegend Utility functions for stratifying datahead-methods Methods for returning the first parts of an
objectinclusionProb Inclusion probabilitieslength-methods Methods for getting the length of an objectplot-methods Plot simulation resultsrunSimulation Run a simulation experimentsetNA Set missing valuessetup Set up multiple samplessimApply Apply a function to subsetssimBwplot Box-and-whisker plotssimDensityplot Kernel density plotssimFrame-package Simulation frameworksimSample Set up multiple samplessimXyplot X-Y plotssrs Random samplingstratify Stratify datasummary-methods Methods for producing a summary of an objecttail-methods Methods for returning the last parts of an
object
Further information is available in the following vignettes:
simFrame-eusilc Applications of Statistical Simulation in the Case of EU-SILC: Using the R Package simFrame (source, pdf)simFrame-intro An Object-Oriented Framework for Statistical Simulation: The R Package simFrame (source, pdf)
UML class diagram
A slightly simplified UML class diagram of the framework can be found in Figure 1 of the packagevignette An Object-Oriented Framework for Statistical Simulation: The R Package simFrame. Use
accessors 5
vignette("simFrame-intro") to view this vignette.
Author(s)
Andreas Alfons [aut, cre]
Maintainer: Andreas Alfons
References
Alfons, A., Templ, M. and Filzmoser, P. (2010) An Object-Oriented Framework for Statistical Sim-ulation: The R Package simFrame. Journal of Statistical Software, 37(3), 136. URL http://www.jstatsoft.org/v37/i03/.
accessors Accessor and mutator functions for objects
Description
Get values of slots of objects via accessor functions and set values via mutator functions. If nomutator methods are available, the slots of the corresponding objects are not supposed to be changedby the user.
Usage
getAdd(x)
getAux(x)setAux(x, aux)
getCall(x, ...)
getCollect(x)setCollect(x, collect)
getColnames(x)setColnames(x, colnames)
getContControl(x)setContControl(x, contControl)
getControl(x)
getDataControl(x)
getDesign(x)setDesign(x, design)
http://www.jstatsoft.org/v37/i03/http://www.jstatsoft.org/v37/i03/
6 accessors
getDistribution(x)setDistribution(x, distribution)
