Learn R Programming

SimDesign

Structure for Organizing Monte Carlo Simulation Designs

Installation

To install the latest stable version of the package from CRAN, please use the following in your R console:

install.packages('SimDesign')

To install the Github version of the package with devtools, type the following (assuming you have already installed the devtools package from CRAN).

library('devtools')
install_github('philchalmers/SimDesign')

Getting started

For a discription pertaining to the philosophy and general workflow of the package it is helpful to first read through the following: Chalmers, R. Philip, Adkins, Mark C. (2020) Writing Effective and Reliable Monte Carlo Simulations with the SimDesign Package, The Quantitative Methods for Psychology, 16(4), 248-280. doi: 10.20982/tqmp.16.4.p248

Coding examples found within this article range from relatively simple (e.g., a re-implementation of one of Hallgren's (2013) simulation study examples, as well as possible extensions to the simulation design) to more advanced real-world simulation experiments (e.g., Flora and Curran's (2004) simulation study). For additional information and instructions about how to use the package please refer to the examples in the associated Github wiki.

Copy Link

Version

Install

install.packages('SimDesign')

Monthly Downloads

6,641

Version

2.18

License

GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

December 14th, 2024

Functions in SimDesign (2.18)

Attach

Attach objects for easier reference
Generate

Generate data
AnalyseIf

Perform a test that indicates whether a given Analyse() function should be executed
BF_sim_alternative

(Alternative) Example simulation from Brown and Forsythe (1974)
MSRSE

Compute the relative performance behavior of collections of standard errors
MAE

Compute the mean absolute error
PBA

Probabilistic Bisection Algorithm
RAB

Compute the relative absolute bias of multiple estimators
RD

Compute the relative difference
RSE

Compute the relative standard error ratio
RMSE

Compute the (normalized) root mean square error
RE

Compute the relative efficiency of multiple estimators
GenerateIf

Perform a test that indicates whether a given Generate() function should be executed
IRMSE

Compute the integrated root mean-square error
SFA

Surrogate Function Approximation via the Generalized Linear Model
Serlin2000

Empirical detection robustness method suggested by Serlin (2000)
RobbinsMonro

Robbins-Monro (1951) stochastic root-finding algorithm
SimCollect

Collapse separate simulation files into a single result
SimClean

Removes/cleans files and folders that have been saved
SimFunctions

Template-based generation of the Generate-Analyse-Summarise functions
SimCheck

Check for missing files in array simulations
SimAnova

Function for decomposing the simulation into ANOVA-based effect sizes
SimExtract

Function to extract extra information from SimDesign objects
SimDesign

Structure for Organizing Monte Carlo Simulation Designs
SimResults

Function to read in saved simulation results
SimShiny

Generate a basic Monte Carlo simulation GUI template
createDesign

Create the simulation design object
bootPredict

Compute prediction estimates for the replication size using bootstrap MSE estimates
colVars

Form Column Standard Deviation and Variances
addMissing

Add missing values to a vector given a MCAR, MAR, or MNAR scheme
bias

Compute (relative/standardized) bias summary statistic
SimSolve

One Dimensional Root (Zero) Finding in Simulation Experiments
clusterSetRNGSubStream

Set RNG sub-stream for Pierre L'Ecuyer's RngStreams
expandDesign

Create the simulation design object
Summarise

Summarise simulated data using various population comparison statistics
manageWarnings

Manage specific warning messages
genSeeds

Generate random seeds
nc

Auto-named Concatenation of Vector or List
rValeMaurelli

Generate non-normal data with Vale & Maurelli's (1983) method
rbind.SimDesign

Combine two separate SimDesign objects by row
manageMessages

Increase the intensity or suppress the output of an observed message
getArrayID

Get job array ID (e.g., from SLURM or other HPC array distributions)
quiet

Suppress verbose function messages
rHeadrick

Generate non-normal data with Headrick's (2002) method
rinvWishart

Generate data with the inverse Wishart distribution
rint

Generate integer values within specified range
reSummarise

Run a summarise step for results that have been saved to the hard drive
rtruncate

Generate a random set of values within a truncated range
runSimulation

Run a Monte Carlo simulation given conditions and simulation functions
rmvt

Generate data with the multivariate t distribution
runArraySimulation

Run a Monte Carlo simulation using array job submissions per condition
rmgh

Generate data with the multivariate g-and-h distribution
rejectionSampling

Rejection sampling (i.e., accept-reject method)
rmvnorm

Generate data with the multivariate normal (i.e., Gaussian) distribution
timeFormater

Format time string to suitable numeric output
Analyse

Compute estimates and statistics
EDR

Compute the empirical detection/rejection rate for Type I errors and Power
ECR

Compute empirical coverage rates
BF_sim

Example simulation from Brown and Forsythe (1974)
Bradley1978

Bradley's (1978) empirical robustness interval
CC

Compute congruence coefficient