SimCheck: Check the status of the simulation's temporary results

Description Usage Arguments Author(s) References See Also Examples

View source: R/SimCheck.R

Description

This function reads the temporary file saved by runSimulation by collapsing the information into a suitable (albeit temporary) object of class 'SimDesign'. This is useful when taking a quick-peak at how the early simulation results are performing (useful long running simulation results with many rows in the Design object). Returns a tibble-based data.frame object (tbl_df).

Usage

1

Arguments

file

the temp file currently saving the simulation state. If missing the file is assumed to be in the current working directory, and start with the name 'SIMDESIGN-TEMPFILE'

Author(s)

Phil Chalmers rphilip.chalmers@gmail.com

References

Chalmers, R. P., & Adkins, M. 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

Sigal, M. J., & Chalmers, R. P. (2016). Play it again: Teaching statistics with Monte Carlo simulation. Journal of Statistics Education, 24(3), 136-156. doi: 10.1080/10691898.2016.1246953

See Also

runSimulation

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 

# explicit
temp_results <- SimCheck(file = 'SIMDESIGN-TEMPFILE_mycomp.rds')
temp_results

# works if file is in the current working directory
temp_results <- SimCheck()
temp_results


## End(Not run)

SimDesign documentation built on Sept. 5, 2021, 5:23 p.m.