From ad341f7ab42cd0b1e58839d6d958898cc65d2ef4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Th=C3=A9riault?=
 <13123390+rempsyc@users.noreply.github.com>
Date: Sun, 24 Sep 2023 10:59:43 -0400
Subject: [PATCH] Add interpretation for fei effect size

---
 DESCRIPTION        | 2 +-
 NAMESPACE          | 1 +
 NEWS.md            | 6 ++++++
 R/interpret.R      | 2 +-
 R/interpret_r.R    | 4 ++++
 man/effectsize.Rd  | 2 +-
 man/interpret_r.Rd | 3 +++
 7 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/DESCRIPTION b/DESCRIPTION
index e6745576f..4c966ee72 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
 Type: Package
 Package: effectsize
 Title: Indices of Effect Size
-Version: 0.8.6
+Version: 0.8.6.1
 Authors@R: 
     c(person(given = "Mattan S.",
              family = "Ben-Shachar",
diff --git a/NAMESPACE b/NAMESPACE
index 358496b63..5c5977eb4 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -139,6 +139,7 @@ export(interpret_direction)
 export(interpret_epsilon_squared)
 export(interpret_ess)
 export(interpret_eta_squared)
+export(interpret_fei)
 export(interpret_g)
 export(interpret_gfi)
 export(interpret_glass_delta)
diff --git a/NEWS.md b/NEWS.md
index ebb789db6..c953d6d2b 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,3 +1,9 @@
+# effectsize 0.8.7
+
+## New features
+
+- New function: `interpret_fei()`
+
 # effectsize 0.8.6
 
 This is a minor update to bring `effectsize` in-line with the formula methods 
diff --git a/R/interpret.R b/R/interpret.R
index b3ee48f7e..6d85e6e45 100644
--- a/R/interpret.R
+++ b/R/interpret.R
@@ -178,7 +178,7 @@ interpret.effectsize_table <- function(x, rules, ...) {
     Cohens_w = ,
     Tschuprows_t = ,
     Tschuprows_t_adjusted = ,
-    fei = interpret_cramers_v(value, rules = rules),
+    Fei = interpret_fei(value, rules = rules),
 
     ## xtab 2x2
     Cohens_h = interpret_cohens_d(value, rules = rules),
diff --git a/R/interpret_r.R b/R/interpret_r.R
index 5565cbb02..c461fd7e7 100644
--- a/R/interpret_r.R
+++ b/R/interpret_r.R
@@ -109,3 +109,7 @@ interpret_cramers_v <- interpret_r
 #' @export
 #' @rdname interpret_r
 interpret_rank_biserial <- interpret_r
+
+#' @export
+#' @rdname interpret_r
+interpret_fei <- interpret_r
diff --git a/man/effectsize.Rd b/man/effectsize.Rd
index f1b55ddfb..7770ab81b 100644
--- a/man/effectsize.Rd
+++ b/man/effectsize.Rd
@@ -22,7 +22,7 @@ effectsize(model, ...)
 \item{type}{The effect size of interest. See details.}
 
 \item{ci}{Value or vector of probability of the CI (between 0 and 1)
-to be estimated. Default to \code{0.95} (\verb{95\%}).}
+to be estimated. Default to \code{.95} (\verb{95\%}).}
 
 \item{test}{The indices of effect existence to compute. Character (vector) or
 list with one or more of these options: \code{"p_direction"} (or \code{"pd"}),
diff --git a/man/interpret_r.Rd b/man/interpret_r.Rd
index b69290160..c8ea33801 100644
--- a/man/interpret_r.Rd
+++ b/man/interpret_r.Rd
@@ -5,6 +5,7 @@
 \alias{interpret_phi}
 \alias{interpret_cramers_v}
 \alias{interpret_rank_biserial}
+\alias{interpret_fei}
 \title{Interpret Correlation Coefficient}
 \usage{
 interpret_r(r, rules = "funder2019", ...)
@@ -14,6 +15,8 @@ interpret_phi(r, rules = "funder2019", ...)
 interpret_cramers_v(r, rules = "funder2019", ...)
 
 interpret_rank_biserial(r, rules = "funder2019", ...)
+
+interpret_fei(r, rules = "funder2019", ...)
 }
 \arguments{
 \item{r}{Value or vector of correlation coefficient.}