-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
74 lines (47 loc) · 3.91 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
---
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%"
)
```
# Hash-Based Matching Pseudo-Random Number Generation <a href='https://hashprng.epinowcast.org'><img src='man/figures/logo.png' align="right" height="139" /></a>
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://github.com/epinowcast/hashprng/actions/workflows/R-CMD-check.yaml) [](https://app.codecov.io/gh/epinowcast/hashprng)
[](https://epinowcast.r-universe.dev/hashprng)
[](https://github.com/epinowcast/hashprng/blob/main/LICENSE.md/)
[](https://github.com/epinowcast/hashprng/graphs/contributors)
Helper functions for use of hash-based matching (HBM) for pseudo-random number generation (PRNG) in stochastic simulations. HBM-PRNG is an approach to simplify matching synthetic experiment samples, which ensures that matched runs different only in the focal parameters, not in their chance events.
## Getting started and learning more
This README is a good place to get started with `hashprng`, in particular the following installation and quick start sections. As you make use of the package, or if your problem requires a richer feature set than presented here, we also provide a range of other reosources.
- [Package website](https://hashprng.epinowcast.org/): This includes a function reference, model outline, and case studies making use of the package. This site refers to the release version of our package. The development version of our documentation (corresponding to our `main` branch on GitHub) is available [here](https://hashprng.epinowcast.org/dev/).
## Installation
### Installing the package
Install the latest GitHub released version of the package with:
```{r, eval = FALSE}
install.packages("hashprng", repos = "https://epinowcast.r-universe.dev")
```
Install the development version (whilst we strive to limit breaking changes or the introduction of bugs during development this version may contain both) from GitHub using the following,
```{r, eval = FALSE}
remotes::install_github("epinowcast/hashprng", dependencies = TRUE)
```
## Quick start
In this quick start ...
## Citation
If you use `hashprng` in your work, please consider citing it using the following,
```{r, echo = FALSE}
citation("hashprng")
```
## How to make a bug report or feature request
Please briefly describe your problem and what output you expect in an [issue](https://github.com/epinowcast/hashprng/issues). If you have a question, please don't open an issue. Instead, ask on our [Q and A page](https://github.com/epinowcast/hashprng/discussions/categories/q-a). See our [contributing guide](https://github.com/epinowcast/hashprng/blob/main/CONTRIBUTING.md) for more information.
## Contributing
We welcome contributions and new contributors! We particularly appreciate help on priority problems in the [issues](https://github.com/epinowcast/hashprng/issues). Please check and add to the issues, and/or add a [pull request](https://github.com/epinowcast/hashprng/pulls). See our [contributing guide](https://github.com/epinowcast/hashprng/blob/main/CONTRIBUTING.md) for more information.
## Code of Conduct
Please note that the hashprng project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.