-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.Rmd
92 lines (61 loc) · 3.29 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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
---
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%"
)
```
# SampleSizePlanner <a href='https://marton-balazs-kovacs.github.io/SampleSizePlanner/'><img src='man/figures/ssp_logo.png' align="right" height="200" /></a>
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->
The goal of SampleSizePlanner is to help researchers determine the sample size for two group designs. The present application and R package offers 9 different sample size planning methods. In addition, the web application allows users to create a justification report for their sample size plan.
## Available sample size planning methods
* Two One‐Sided Tests (TOST)
* Interval Equivalence Bayes factor
* Classical power analysis
* Power curve
* Bayes Factor Design Analysis (BFDA)
* Predetermined sample size with Bayes factor
* Accuracy In Parameter Estimation (AIPE)
* A-priori precision (APP)
* Region of Practical Equivalence (ROPE)
* Non-inferiority Bayes factor
## Usage
SampleSizePlanner can be used either via the web app or via R.
### Using the web app
You can use the app at [https://martonbalazskovacs.shinyapps.io/SampleSizePlanner/](https://martonbalazskovacs.shinyapps.io/SampleSizePlanner/).
You can alternatively run the app locally on your own computer by following these instructions:
Install the development version (SampleSizePlanner is not available from CRAN) from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("marton-balazs-kovacs/SampleSizePlanner")
```
Running the app.
``` r
SampleSizePlanner::run_app()
```
### Using the package
You can use the R package to determine the sample size with any of the 9 methods that present in the web app. However, it is not possible currently to generate a justification report from the R package. Please see the tutorial paper or the web app for example sample size justifications for each method.
The tutorial paper for two-group study designs can be found [HERE](https://journals.sagepub.com/doi/pdf/10.1177/25152459211054059).
## Citation
Please cite `SampleSizePlanner` if you use it for determining your sample size. To cite SampleSizePlanner the software, use:
```{r echo = FALSE, results = "asis"}
print(citation("SampleSizePlanner"), style = "text")
```
Or copy the reference information to your BibTeX file:
~~~bibtex
```{r echo = FALSE, results = "asis"}
print(citation("SampleSizePlanner"), style = "Bibtex")
```
~~~
To cite the tutorial paper on two-group designs use:
Kovacs, M., van Ravenzwaaij, D., Hoekstra, R., & Aczel, B. (2022). SampleSizePlanner: A tool to estimate and justify sample size for two-group studies. _Advances in Methods and Practices in Psychological Science, 5_(1), 25152459211054059.
## Code of Conduct
We are open to new ideas and feature requests.
Please note that the SampleSizePlanner project is released with a [Contributor Code of Conduct](https://marton-balazs-kovacs.github.io/SampleSizePlanner/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.