-
-
Notifications
You must be signed in to change notification settings - Fork 22
/
README.Rmd
220 lines (144 loc) · 8.14 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
---
output: github_document
---
# effectsize: Indices of Effect Size <img src="man/figures/logo.png" align="right" width="120" />
```{r setup, echo = FALSE, warning=FALSE, message=FALSE}
library(effectsize)
options(digits = 3)
knitr::opts_chunk$set(
collapse = TRUE,
dpi = 450,
fig.path = "man/figures/"
)
set.seed(111)
```
[](https://doi.org/10.21105/joss.02815)
[](https://cran.r-project.org/package=effectsize/)
[](https://cran.r-project.org/package=effectsize/)
[](https://CRAN.R-project.org/package=effectsize/)
[](https://lifecycle.r-lib.org/articles/stages.html)
***Significant is just not enough!***
The goal of this package is to provide utilities to work with indices of effect size and standardized parameters, allowing computation and conversion of indices such as Cohen's *d*, *r*, odds-ratios, etc.
## Installation
[](https://cran.r-project.org/package=effectsize/)
[](https://easystats.r-universe.dev/)
[](https://github.com/easystats/effectsize/actions)
[](https://github.com/easystats/effectsize/actions/)
[](https://app.codecov.io/gh/easystats/effectsize?branch=main/)
Run the following to install the stable release of **effectsize** from CRAN:
```{r install-CRAN, warning=FALSE, message=FALSE, eval=FALSE}
install.packages("effectsize")
```
Or you can install the latest development version from [*R-universe*](https://easystats.r-universe.dev):
```{r install-R-universe, warning=FALSE, message=FALSE, eval=FALSE}
install.packages("effectsize", repos = "https://easystats.r-universe.dev/")
```
<!-- Or from *GitHub*: -->
<!-- ```{r, warning=FALSE, message=FALSE, eval=FALSE} -->
<!-- if (!require("remotes")) install.packages("remotes") -->
<!-- remotes::install_github("easystats/effectsize") -->
<!-- ``` -->
## Documentation
[](https://easystats.github.io/effectsize/)
[](https://easystats.github.io/blog/posts/)
[](https://easystats.github.io/effectsize/reference/index.html)
Click on the buttons above to access the package [**documentation**](https://easystats.github.io/effectsize/) and the [**easystats blog**](https://easystats.github.io/blog/posts/), and check-out these vignettes:
- **Effect Sizes**
- [**Standardized Differences**](https://easystats.github.io/effectsize/articles/standardized_differences.html)
- [**For Contingency Tables**](https://easystats.github.io/effectsize/articles/xtabs.html)
- [**ANOVA Effect Sizes**](https://easystats.github.io/effectsize/articles/anovaES.html)
- **Effect Sizes Conversion**
- [**Between Effect Sizes**](https://easystats.github.io/effectsize/articles/convert_r_d_OR.html)
- [**Between Probabilities and Odds and Risk Ratios**](https://easystats.github.io/effectsize/articles/convert_p_OR_RR.html)
- [**Effect Size from Test Statistics**](https://easystats.github.io/effectsize/articles/from_test_statistics.html)
- [**Plotting Functions for the 'effectsize' Package**](https://easystats.github.io/see/articles/effectsize.html)
- [**Automated Interpretation of Indices of Effect Size**](https://easystats.github.io/effectsize/articles/interpret.html)
# Features
This package is focused on indices of effect size. Check out the package website for [**a full list of features and functions** provided by `effectsize`](https://easystats.github.io/effectsize/reference/index.html).
```{r load, message=FALSE, warning=FALSE}
library(effectsize)
options(es.use_symbols = TRUE) # get nice symbols when printing! (On Windows, requires R >= 4.2.0)
```
> **Tip:**
>
> **Instead of `library(effectsize)`, use `library(easystats)`.**
> **This will make all features of the easystats-ecosystem available.**
>
> **To stay updated, use `easystats::install_latest()`.**
## Effect Size Computation
The package provides functions to compute indices of effect size.
### Standardized Differences (Cohen's *d*, Hedges' *g*, Glass' *delta*)
```{r d, warning=FALSE, message=FALSE}
cohens_d(mpg ~ am, data = mtcars)
hedges_g(mpg ~ am, data = mtcars)
glass_delta(mpg ~ am, data = mtcars)
```
`effectsize` also provides effect sizes for *paired standardized differences*, *rank tests*, *common language effect sizes* and more...
### Contingency Tables
```{r}
# Dependence
phi(mtcars$am, mtcars$vs)
cramers_v(mtcars$am, mtcars$cyl)
# Goodness-of-fit
fei(table(mtcars$cyl), p = c(0.1, 0.3, 0.6))
```
### ANOVAs (Eta<sup>2</sup>, Omega<sup>2</sup>, ...)
```{r aov, warning=FALSE, message=FALSE}
model <- aov(mpg ~ factor(gear), data = mtcars)
eta_squared(model)
omega_squared(model)
epsilon_squared(model)
```
And more...
<!-- ### Regression Models (Standardized Parameters) -->
<!-- Importantly, `effectsize` also provides [advanced methods](https://easystats.github.io/effectsize/articles/standardize_parameters.html) to compute standardized parameters for regression models. -->
<!-- ```{r beta, warning=FALSE, message=FALSE} -->
<!-- m <- lm(rating ~ complaints + privileges + advance, data = attitude) -->
<!-- standardize_parameters(m) -->
<!-- ``` -->
<!-- Also, models can be re-fit with standardized data: -->
<!-- ```{r std-model, warning=FALSE, message=FALSE} -->
<!-- standardize(m) -->
<!-- ``` -->
## Effect Size Conversion
The package also provides ways of converting between different effect sizes.
```{r convert-between, warning=FALSE, message=FALSE}
d_to_r(d = 0.2)
oddsratio_to_riskratio(2.6, p0 = 0.4)
```
And for recovering effect sizes from test statistics.
```{r convert-stat, warning=FALSE, message=FALSE}
F_to_d(15, df = 1, df_error = 60)
F_to_r(15, df = 1, df_error = 60)
F_to_eta2(15, df = 1, df_error = 60)
```
## Effect Size Interpretation
The package allows for an automated interpretation of different indices.
```{r interp-r, warning=FALSE, message=FALSE}
interpret_r(r = 0.3)
```
Different sets of "rules of thumb" are implemented ([**guidelines are detailed here**](https://easystats.github.io/effectsize/articles/interpret.html)) and can be easily changed.
```{r interp-d, warning=FALSE, message=FALSE}
interpret_cohens_d(d = 0.45, rules = "cohen1988")
interpret_cohens_d(d = 0.45, rules = "gignac2016")
```
### Citation
In order to cite this package, please use the following citation:
* Ben-Shachar M, Lüdecke D, Makowski D (2020). effectsize: Estimation of Effect Size Indices and Standardized Parameters. _Journal of Open Source Software_, *5*(56), 2815. doi: 10.21105/joss.02815
Corresponding BibTeX entry:
```
@Article{,
title = {{e}ffectsize: Estimation of Effect Size Indices and Standardized Parameters},
author = {Mattan S. Ben-Shachar and Daniel Lüdecke and Dominique Makowski},
year = {2020},
journal = {Journal of Open Source Software},
volume = {5},
number = {56},
pages = {2815},
publisher = {The Open Journal},
doi = {10.21105/joss.02815},
url = {https://doi.org/10.21105/joss.02815}
}
```
# Contributing and Support
If you have any questions regarding the the functionality of the package, you may either contact us via email or also [file an issue](https://github.com/easystats/effectsize/issues/). Anyone wishing to contribute to the package by adding functions, features, or in another way, please follow [this guide](https://github.com/easystats/effectsize/blob/main/.github/CONTRIBUTING.md/) and our [code of conduct](https://github.com/easystats/effectsize/blob/main/.github/CODE_OF_CONDUCT.md/).