README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# sims

<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![R-CMD-check](https://github.com/poissonconsulting/sims/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/poissonconsulting/sims/actions/workflows/R-CMD-check.yaml)
[![Codecov](https://codecov.io/gh/poissonconsulting/sims/graph/badge.svg)](https://app.codecov.io/gh/poissonconsulting/sims)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![CRAN status](https://www.r-pkg.org/badges/version/sims)](https://cran.r-project.org/package=sims)
![CRAN downloads](http://cranlogs.r-pkg.org/badges/sims)
<!-- badges: end -->

sims is an R package to generate datasets from R or [JAGS](https://mcmc-jags.sourceforge.io/) code for use in simulation studies.
The datasets are returned as an [nlists](https://github.com/poissonconsulting/nlist) object and/or saved to file as individual .rds files.
Parallelization is implemented using the  [future](https://github.com/HenrikBengtsson/future) package.
Progress is reported using the [progressr](https://github.com/HenrikBengtsson/progressr) package.

## Installation

You can install the released version of sims from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("sims")
```

And the development version from [GitHub](https://github.com/poissonconsulting/sims) with:

``` r
# 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](https://github.com/poissonconsulting/nlist) object.

```{r example}
library(sims)
set.seed(10)
sims_simulate("a <- runif(1)", nsims = 2L)
```

If, however, `save = TRUE` then each nlist object is saved as an `.rds` file in `path`.
```{r}
set.seed(10)
sims_simulate("a <- runif(1)", nsims = 2L, save = TRUE, path = tempdir(), exists = NA)
sims_data_files(tempdir())
sims_data(tempdir())
```

## Information

For more information see the [Get Started](https://poissonconsulting.github.io/sims/articles/sims.html) vignette.

## Contribution

Please report any [issues](https://github.com/poissonconsulting/sims/issues).

[Pull requests](https://github.com/poissonconsulting/sims/pulls) are always welcome.

## Code of Conduct

Please note that the sims project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.