Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AngusMcLure authored May 6, 2024
1 parent 1abfcef commit 126e23a
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@
[![codecov](https://codecov.io/gh/AngusMcLure/PoolPoweR/graph/badge.svg?token=OCUMCG50JU)](https://codecov.io/gh/AngusMcLure/PoolPoweR)
<!-- badges: end -->

Power and sample size calculations for surveys using pool testing (AKA group testing).
Power and sample size calculations, and design optimisaiton tools for surveys using pool testing (AKA group testing).

For a code-free user interface to this package see [PoolTools](https://fredjaya.shinyapps.io/pooltools/).

This package is under construction, with new functionality been added often. Though we are confident that implemented code is correct and have provided extensive documentation and tests within the package, the names of functions, inputs, and outputs may change over time.
This package is under construction, with new functionality added often. Though we are confident that implemented code is (mostly) correct and have provided extensive documentation and tests within the package, the names of functions, inputs, and outputs may change over time.

## Installation
```r
# install.packages("devtools")
devtools::install_github("AngusMcLure/PoolPoweR")
```

## Citation
## Citation
A journal article detailing the methods used for evaluating and optimising surveys will be available soon. In the interim please cite this website if you use our tool:

> McLure, A., & Jaya, F. PoolPoweR [Computer software]. https://github.com/AngusMcLure/PoolPoweR

0 comments on commit 126e23a

Please sign in to comment.