Package: simFrame 0.5.4
simFrame: Simulation Framework
A general framework for statistical simulation, which allows researchers to make use of a wide range of simulation designs with minimal programming effort. The package provides functionality for drawing samples from a distribution or a finite population, for adding outliers and missing values, as well as for visualization of the simulation results. It follows a clear object-oriented design and supports parallel computing to increase computational performance.
Authors:
simFrame_0.5.4.tar.gz
simFrame_0.5.4.zip(r-4.5)simFrame_0.5.4.zip(r-4.4)simFrame_0.5.4.zip(r-4.3)
simFrame_0.5.4.tgz(r-4.4-x86_64)simFrame_0.5.4.tgz(r-4.4-arm64)simFrame_0.5.4.tgz(r-4.3-x86_64)simFrame_0.5.4.tgz(r-4.3-arm64)
simFrame_0.5.4.tar.gz(r-4.5-noble)simFrame_0.5.4.tar.gz(r-4.4-noble)
simFrame_0.5.4.tgz(r-4.4-emscripten)simFrame_0.5.4.tgz(r-4.3-emscripten)
simFrame.pdf |simFrame.html✨
simFrame/json (API)
NEWS
| # Install 'simFrame' in R: |
| install.packages('simFrame', repos = c('https://aalfons.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/aalfons/simframe/issues
Datasets:
- eusilcP - Synthetic EU-SILC data
Last updated 3 years agofrom:23314f0b1f. Checks:OK: 9. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Sep 05 2024 |
| R-4.5-win-x86_64 | OK | Sep 05 2024 |
| R-4.5-linux-x86_64 | OK | Sep 05 2024 |
| R-4.4-win-x86_64 | OK | Sep 05 2024 |
| R-4.4-mac-x86_64 | OK | Sep 05 2024 |
| R-4.4-mac-aarch64 | OK | Sep 05 2024 |
| R-4.3-win-x86_64 | OK | Sep 05 2024 |
| R-4.3-mac-x86_64 | OK | Sep 05 2024 |
| R-4.3-mac-aarch64 | OK | Sep 05 2024 |
Exports:aggregatebrewerclusterRunSimulationclusterSetupcontaminateContControlDARContControlDataControlDCARContControldrawgenerategetAddgetAuxgetCallgetCollectgetColnamesgetContControlgetControlgetDataControlgetDesigngetDistributiongetDotsgetEpsilongetFungetGroupinggetIndicesgetIntoContaminationgetKgetLegendgetNAControlgetNArategetNrgetNrepgetProbgetSAEgetSampleControlgetSeedgetSizegetSplitgetStrataLegendgetStrataSplitgetStrataTablegetStratumSizesgetStratumValuesgetTargetgetValuesheadinclusionProbmidzunoNAControlplotrunSimrunSimulationSampleControlSampleSetupsetAuxsetCollectsetColnamessetContControlsetDesignsetDistributionsetDotssetEpsilonsetFunsetGroupingsetIntoContaminationsetKsetNAsetNAControlsetNAratesetProbsetSAEsetSizesetTargetsetupshowsimApplysimBwplotSimControlsimDensityplotSimResultssimSamplesimSapplysimXyplotsrsStratastratifysummarySummarySampleSetuptailtilleTwoStageControlups
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Simulation Framework | SimFrame-package Simframe-package simFrame-package simframe-package SimFrame Simframe simFrame simframe |
| Accessor and mutator functions for objects | getAdd getAdd-methods getAux getAux-methods getCall getCall-methods getCollect getCollect-methods getColnames getColnames-methods getContControl getContControl-methods getControl getControl-methods getDataControl getDataControl-methods getDesign getDesign-methods getDistribution getDistribution-methods getDots getDots,TwoStageControl-method getDots-methods getEpsilon getEpsilon-methods getFun getFun,TwoStageControl-method getFun-methods getGrouping getGrouping-methods getIndices getIndices-methods getIntoContamination getIntoContamination-methods getK getK-methods getLegend getLegend-methods getNAControl getNAControl-methods getNArate getNArate-methods getNr getNr-methods getNrep getNrep-methods getProb getProb,TwoStageControl-method getProb-methods getSAE getSAE-methods getSampleControl getSampleControl-methods getSeed getSeed-methods getSize getSize,TwoStageControl-method getSize-methods getSplit getSplit-methods getTarget getTarget-methods getValues getValues-methods setAux setAux-methods setCollect setCollect-methods setColnames setColnames-methods setContControl setContControl-methods setDesign setDesign-methods setDistribution setDistribution-methods setDots setDots,TwoStageControl-method setDots-methods setEpsilon setEpsilon-methods setFun setFun,TwoStageControl-method setFun-methods setGrouping setGrouping-methods setIntoContamination setIntoContamination-methods setK setK-methods setNAControl setNAControl-methods setNArate setNArate-methods setProb setProb,TwoStageControl-method setProb-methods setSAE setSAE-methods setSize setSize,TwoStageControl-method setSize-methods setTarget setTarget-methods |
| Method for aggregating simulation results | aggregate,SimResults-method aggregate-methods |
| Class "BasicVector" | BasicVector-class Basicvector-class basicVector-class basicvector-class |
| Run a simulation experiment on a cluster | ClusterRunSimulation ClusterRunsimulation ClusterrunSimulation Clusterrunsimulation clusterRunSimulation clusterRunsimulation clusterrunSimulation clusterrunsimulation clusterRunSimulation,ANY,ANY,ANY,ANY,missing-method clusterRunSimulation,ANY,data.frame,missing,numeric,SimControl-method clusterRunSimulation,ANY,data.frame,SampleSetup,missing,SimControl-method clusterRunSimulation,ANY,data.frame,VirtualSampleControl,missing,SimControl-method clusterRunSimulation,ANY,VirtualDataControl,missing,numeric,SimControl-method clusterRunSimulation,ANY,VirtualDataControl,VirtualSampleControl,numeric,SimControl-method clusterRunSimulation-methods |
| Set up multiple samples on a cluster | ClusterSetup Clustersetup clusterSetup clustersetup clusterSetup,ANY,data.frame,character-method clusterSetup,ANY,data.frame,missing-method clusterSetup,ANY,data.frame,SampleControl-method clusterSetup,ANY,data.frame,TwoStageControl-method clusterSetup-methods |
| Contaminate data | contaminate contaminate,data.frame,character-method contaminate,data.frame,ContControl-method contaminate,data.frame,missing-method contaminate-methods |
| Create contamination control objects | ContControl Contcontrol contControl contcontrol |
| Class "ContControl" | ContControl-class Contcontrol-class contControl-class contcontrol-class getAux,ContControl-method getGrouping,ContControl-method setAux,ContControl-method setGrouping,ContControl-method show,ContControl-method |
| Class "DARContControl" | DARContControl DARContcontrol DARcontControl DARcontcontrol darContcontrol darcontControl darcontcontrol DARContControl-class DARContcontrol-class DARcontControl-class DARcontcontrol-class darContcontrol-class darcontControl-class darcontcontrol-class getDots,DARContControl-method getFun,DARContControl-method setDots,DARContControl-method setFun,DARContControl-method |
| Class "DataControl" | DataControl Datacontrol dataControl datacontrol DataControl-class Datacontrol-class dataControl-class datacontrol-class getColnames,DataControl-method getDistribution,DataControl-method getDots,DataControl-method getSize,DataControl-method setColnames,DataControl-method setDistribution,DataControl-method setDots,DataControl-method setSize,DataControl-method show,DataControl-method |
| Class "DCARContControl" | DCARContControl DCARContcontrol DCARcontControl DCARcontcontrol dcarContcontrol dcarcontControl dcarcontcontrol DCARContControl-class DCARContcontrol-class DCARcontControl-class DCARcontcontrol-class dcarContcontrol-class dcarcontControl-class dcarcontcontrol-class getDistribution,DCARContControl-method getDots,DCARContControl-method setDistribution,DCARContControl-method setDots,DCARContControl-method |
| Draw a sample | draw draw,data.frame,character-method draw,data.frame,missing-method draw,data.frame,SampleSetup-method draw,data.frame,VirtualSampleControl-method draw-methods |
| Synthetic EU-SILC data | eusilcP eusilcp |
| Generate data | generate generate,character-method generate,DataControl-method generate,missing-method generate-methods |
| Methods for returning the first parts of an object | head,SampleSetup-method head,SimControl-method head,SimResults-method head,Strata-method head,VirtualContControl-method head,VirtualDataControl-method head,VirtualNAControl-method head,VirtualSampleControl-method head-methods |
| Inclusion probabilities | InclusionProb inclusionProb inclusionprob |
| Methods for getting the length of an object | length,SampleSetup-method length,VirtualContControl-method length,VirtualNAControl-method length,VirtualSampleControl-method length-methods |
| Class "NAControl" | getAux,NAControl-method getGrouping,NAControl-method getIntoContamination,NAControl-method NAControl NAcontrol naControl nacontrol NAControl-class NAcontrol-class naControl-class nacontrol-class setAux,NAControl-method setGrouping,NAControl-method setIntoContamination,NAControl-method show,NAControl-method |
| Class "NumericMatrix" | NumericMatrix-class Numericmatrix-class numericMatrix-class numericmatrix-class |
| Class "OptBasicVector" | OptBasicVector-class OptBasicvector-class OptbasicVector-class optBasicVector-class optBasicvector-class optbasicVector-class optbasicvector-class Optsbasicvector-class |
| Class "OptCall" | OptCall-class Optcall-class optCall-class optcall-class |
| Class "OptCharacter" | OptCharacter-class Optcharacter-class optCharacter-class optcharacter-class |
| Class "OptContControl" | OptContControl-class OptContcontrol-class OptcontControl-class Optcontcontrol-class optContControl-class optContcontrol-class optcontControl-class optcontcontrol-class |
| Class "OptDataControl" | OptDataControl-class OptDatacontrol-class OptdataControl-class Optdatacontrol-class optDataControl-class optDatacontrol-class optdataControl-class optdatacontrol-class |
| Class "OptNAControl" | OptNAControl-class OptNAcontrol-class OptnaControl-class Optnacontrol-class optNAControl-class optNAcontrol-class optnaControl-class optnacontrol-class |
| Class "OptNumeric" | OptNumeric-class Optnumeric-class optNumeric-class optnumeric-class |
| Class "OptSampleControl" | OptSampleControl-class OptSamplecontrol-class OptsampleControl-class Optsamplecontrol-class optSampleControl-class optSamplecontrol-class optsampleControl-class optsamplecontrol-class |
| Plot simulation results | plot,SimResults,missing-method plot-methods |
| Run a simulation experiment | runSim RunSimulation Runsimulation runSimulation runsimulation runSimulation,ANY,ANY,ANY,missing-method runSimulation,data.frame,missing,missing,SimControl-method runSimulation,data.frame,missing,numeric,SimControl-method runSimulation,data.frame,SampleSetup,missing,SimControl-method runSimulation,data.frame,VirtualSampleControl,missing,SimControl-method runSimulation,VirtualDataControl,missing,missing,SimControl-method runSimulation,VirtualDataControl,missing,numeric,SimControl-method runSimulation,VirtualDataControl,VirtualSampleControl,missing,SimControl-method runSimulation,VirtualDataControl,VirtualSampleControl,numeric,SimControl-method RunSimulation-methods Runsimulation-methods runSimulation-methods runsimulation-methods |
| Class "SampleControl" | getCollect,SampleControl-method getDesign,SampleControl-method getDots,SampleControl-method getFun,SampleControl-method getGrouping,SampleControl-method getProb,SampleControl-method getSize,SampleControl-method SampleControl Samplecontrol sampleControl samplecontrol SampleControl-class Samplecontrol-class sampleControl-class samplecontrol-class setCollect,SampleControl-method setDesign,SampleControl-method setDots,SampleControl-method setFun,SampleControl-method setGrouping,SampleControl-method setProb,SampleControl-method setSize,SampleControl-method show,SampleControl-method |
| Class "SampleSetup" | getCall,SampleSetup-method getControl,SampleSetup-method getIndices,SampleSetup-method getProb,SampleSetup-method getSeed,SampleSetup-method SampleSetup Samplesetup sampleSetup samplesetup SampleSetup-class Samplesetup-class sampleSetup-class samplesetup-class show,SampleSetup-method |
| Random sampling | brewer midzuno srs tille ups |
| Set missing values | SetNA Setna setNA setna setNA,data.frame,character-method setNA,data.frame,missing-method setNA,data.frame,NAControl-method SetNA-methods Setna-methods setNA-methods setna-methods |
| Set up multiple samples | setup setup,data.frame,character-method setup,data.frame,missing-method setup,data.frame,SampleControl-method setup,data.frame,TwoStageControl-method setup-methods |
| Apply a function to subsets | SimApply Simapply simApply simapply simApply,data.frame,BasicVector,function-method simApply,data.frame,Strata,function-method SimApply-methods Simapply-methods simApply-methods simapply-methods SimSapply Simsapply simSapply simsapply simSapply,data.frame,BasicVector,function-method simSapply,data.frame,Strata,function-method SimSapply-methods Simsapply-methods simSapply-methods simsapply-methods |
| Box-and-whisker plots | SimBwplot simBwplot simbwplot simBwplot,SimResults-method SimBwplot-methods simBwplot-methods simbwplot-methods |
| Class "SimControl" | getContControl,SimControl-method getDesign,SimControl-method getDots,SimControl-method getFun,SimControl-method getNAControl,SimControl-method getSAE,SimControl-method setContControl,SimControl-method setDesign,SimControl-method setDots,SimControl-method setFun,SimControl-method setNAControl,SimControl-method setSAE,SimControl-method show,SimControl-method SimControl Simcontrol simControl simcontrol SimControl-class Simcontrol-class simControl-class simcontrol-class |
| Kernel density plots | SimDensityplot Simdensityplot simDensityplot simdensityplot simDensityplot,SimResults-method SimDensityplot-methods Simdensityplot-methods simDensityplot-methods simdensityplot-methods |
| Class "SimResults" | getAdd,SimResults-method getCall,SimResults-method getColnames,SimResults-method getControl,SimResults-method getDataControl,SimResults-method getDesign,SimResults-method getEpsilon,SimResults-method getNArate,SimResults-method getNrep,SimResults-method getSampleControl,SimResults-method getSeed,SimResults-method getValues,SimResults-method show,SimResults-method SimResults Simresults simResults simresults SimResults-class Simresults-class simResults-class simresults-class |
| Set up multiple samples | SimSample Simsample simSample simsample |
| X-Y plots | SimXyplot Simxyplot simXyplot simxyplot simXyplot,SimResults-method SimXyplot-methods Simxyplot-methods simXyplot-methods simxyplot-methods |
| Class "Strata" | getCall,Strata-method getDesign,Strata-method getLegend,Strata-method getNr,Strata-method getSize,Strata-method getSplit,Strata-method getValues,Strata-method show,Strata-method Strata strata Strata-class strata-class |
| Stratify data | stratify stratify,data.frame,BasicVector-method stratify-methods |
| Utility functions for stratifying data | getStrataLegend getStrataLegend,data.frame,BasicVector-method getStrataLegend-methods getStrataSplit getStrataSplit,data.frame,BasicVector-method getStrataSplit-methods getStrataTable getStrataTable,data.frame,BasicVector-method getStrataTable-methods getStratumSizes getStratumSizes,data.frame,BasicVector-method getStratumSizes,list,missing-method getStratumSizes-methods getStratumValues getStratumValues,data.frame,BasicVector,list-method getStratumValues,data.frame,BasicVector,missing-method getStratumValues-methods |
| Methods for producing a summary of an object | summary,SampleSetup-method summary,SimControl-method summary,SimResults-method summary,Strata-method summary,VirtualContControl-method summary,VirtualDataControl-method summary,VirtualNAControl-method summary,VirtualSampleControl-method summary-methods |
| Class "SummarySampleSetup" | getSize,SummarySampleSetup-method show,SummarySampleSetup-method SummarySampleSetup SummarySamplesetup SummarysampleSetup Summarysamplesetup summarySampleSetup summarySamplesetup summarysampleSetup summarysamplesetup SummarySampleSetup-class SummarySamplesetup-class SummarysampleSetup-class Summarysamplesetup-class summarySampleSetup-class summarySamplesetup-class summarysampleSetup-class summarysamplesetup-class |
| Methods for returning the last parts of an object | tail,SampleSetup-method tail,SimControl-method tail,SimResults-method tail,Strata-method tail,VirtualContControl-method tail,VirtualDataControl-method tail,VirtualNAControl-method tail,VirtualSampleControl-method tail-methods |
| Class "TwoStageControl" | getDesign,TwoStageControl-method getGrouping,TwoStageControl-method setDesign,TwoStageControl-method setGrouping,TwoStageControl-method show,TwoStageControl-method TwoStageControl TwoStagecontrol TwostageControl Twostagecontrol twoStageControl twoStagecontrol twostageControl twostagecontrol TwoStageControl-class TwoStagecontrol-class TwostageControl-class Twostagecontrol-class twoStageControl-class twoStagecontrol-class twostageControl-class twostagecontrol-class |
| Class "VirtualContControl" | getEpsilon,VirtualContControl-method getTarget,VirtualContControl-method setEpsilon,VirtualContControl-method setTarget,VirtualContControl-method show,VirtualContControl-method VirtualContControl-class VirtualContcontrol-class VirtualcontControl-class Virtualcontcontrol-class virtualContControl-class virtualContcontrol-class virtualcontControl-class virtualcontcontrol-class |
| Class "VirtualDataControl" | VirtualDataControl-class VirtualDatacontrol-class VirtualdataControl-class Virtualdatacontrol-class virtualDataControl-class virtualDatacontrol-class virtualdataControl-class virtualdatacontrol-class |
| Class "VirtualNAControl" | getNArate,VirtualNAControl-method getTarget,VirtualNAControl-method setNArate,VirtualNAControl-method setTarget,VirtualNAControl-method show,VirtualNAControl-method VirtualNAControl-class VirtualNAcontrol-class VirtualnaControl-class Virtualnacontrol-class virtualNAControl-class virtualNAcontrol-class virtualnaControl-class virtualnacontrol-class |
| Class "VirtualSampleControl" | getK,VirtualSampleControl-method setK,VirtualSampleControl-method show,VirtualSampleControl-method VirtualSampleControl-class VirtualSamplecontrol-class VirtualsampleControl-class Virtualsamplecontrol-class virtualSampleControl-class virtualSamplecontrol-class virtualsampleControl-class virtualsamplecontrol-class |
