sims

Lifecycle: maturing R build status Codecov test coverage License: MIT CRAN status CRAN downloads

sims is an R package to generate datasets from R or JAGS code for use in simulation studies. The datasets are returned as an nlists object and/or saved to file as individual .rds files. Parallelization is implemented using the future package. Progress is reported using the progressr package.

Installation

To install the developmental version from GitHub

# install.packages("remotes")
remotes::install_github("poissonconsulting/sims")

Demonstration

Simulate Data

By default, sims_simulate() returns the simulated datasets in the form of an nlists object.

library(sims)
set.seed(10)
sims_simulate("a ~ dunif(0,1)", nsims = 2L)
#> $a
#> [1] 0.6857306
#> 
#> an nlists object of 2 nlist objects each with 1 numeric element

If, however, save = TRUE then each nlist object is saved as an .rds file in path.

set.seed(10)
sims_simulate("a ~ dunif(0,1)", nsims = 2L, save = TRUE, path = tempdir(), exists = NA)
#> [1] TRUE
sims_data_files(tempdir())
#> [1] "data0000001.rds" "data0000002.rds"
sims_data(tempdir())
#> $a
#> [1] 0.6857306
#> 
#> an nlists object of 2 nlist objects each with 1 numeric element

Information

For more information see the Get Started vignette.

Contribution

Please report any issues.

Pull requests are always welcome.

Code of Conduct

Please note that the sims project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.