-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
84 lines (60 loc) · 3.78 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
---
output: github_document
editor_options:
markdown:
wrap: sentence
always_allow_html: yes
---
<!-- README.md is generated from README.Rmd. Please edit this file -->
```{r, include = FALSE, cache = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
out.width = "100%"
)
# Turn on ANSI colors
asciicast::init_knitr_engine(
startup = quote({
library(cli)
set.seed(1) }),
echo = FALSE,
echo_input = FALSE)
```
# `cTOST` Overview <a href="https://yboulag.github.io/cTOST/"><img src="man/figures/hex-cTOST.png" alt="" align="right" height="138" width="125" /></a>
<!-- badges: start -->
[](https://opensource.org/licenses/AGPL-3.0)
[)`-green.svg)](https://github.com/yboulag/cTOST)
[](https://github.com/yboulag/cTOST/actions/workflows/R-CMD-check.yaml)
[](https://www.r-pkg.org/pkg/cTOST)
[](https://www.r-pkg.org/pkg/cTOST)
<!-- badges: end -->
## Overview
This repository holds the `cTOST` R package. This package contains the function `tost` which provides an assessment of equivalence in the univariate framework based on the state-of-the-art Two One-Sided Tests (TOST). In addition, the package contains the functions `atost` and `dtost`, two corrective procedures applied to the TOST in the univariate framework in order to ensure the preservation of the Type I error rate at the desired nominal level and a uniform increase in power. These two functions output an assessment of equivalence in the univariate framework after their respective corrections is applied. More details can be found in Boulaguiem et al. (2024) that you can access via this [link](https://doi.org/10.1002/sim.9993).
## Install Instructions
The `cTOST` package is available on both CRAN and GitHub. The CRAN version is considered stable, whereas the GitHub version is subject to modifications/updates which may lead to installation problems or broken functions. You can install the stable version of the `cTOST` package with:
```{r, eval=FALSE}
install.packages("cTOST")
```
In order to install the latest version from GitHub, it is required to pre-install the `devtools` dependency. Run the following command if you do not have it already installed:
```{r, eval=FALSE}
install.packages("devtools")
```
The package is then installed with the following command:
```{r, eval=FALSE}
devtools::install_github("yboulag/cTOST")
```
Note that Windows users are assumed to have Rtools installed (if this is not the case, please visit this [link](https://cran.r-project.org/bin/windows/Rtools/)).
## How to cite
```{}
@Manual{boulaguiem2023ctost,
title = {cTOST: Finite Sample Correction of The TOST in The Univariate Framework},
author = {Younes Boulaguiem and Stéphane Guerrier and Dominique-Laurent Couturier},
year = {2023},
note = {R package version 1.0.0},
url = {https://github.com/yboulag/cTOST},
}
```
## License
The license this source code is released under is the GNU AFFERO GENERAL PUBLIC LICENSE (AGPL) v3.0. Please see the LICENSE file for full text. Otherwise, please consult [GNU](https://www.gnu.org/licenses/agpl-3.0.en.html) which will provide a synopsis of the restrictions placed upon the code.
## References
Boulaguiem, Y., Quartier, J., Lapteva, M., Kalia, Y. N., Victoria-Feser, M. P., Guerrier, S., & Couturier, D. L., "*Finite Sample Adjustments for Average Equivalence Testing*", Statistics in Medicine, 2024, [https://doi.org/10.1002/sim.9993]( https://doi.org/10.1002/sim.9993).