Skip to content

Commit 563905c

Browse files
committed
added depreciation warning/error to delta_g attribute, telling users to use hedges_g when delta2=True
1 parent e8f1176 commit 563905c

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

dabest/_dabest_object.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,15 @@ def cliffs_delta(self):
242242
"""
243243
return self.__cliffs_delta
244244

245+
246+
@property
247+
def delta_g(self):
248+
"""
249+
Returns an :py:class:`EffectSizeDataFrame` for deltas' g, its confidence interval, and relevant statistics, for all comparisons as indicated via the `idx` and `paired` argument in `dabest.load()`.
250+
"""
251+
raise DeprecationWarning("delta_g has been depreciated - Please use hedges_g (with delta2=True) for deltas' g experiments")
252+
253+
245254
@property
246255
def input_data(self):
247256
"""

nbs/API/dabest_object.ipynb

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,15 @@
347347
" \"\"\"\n",
348348
" return self.__cliffs_delta\n",
349349
"\n",
350+
"\n",
351+
" @property\n",
352+
" def delta_g(self):\n",
353+
" \"\"\"\n",
354+
" Returns an :py:class:`EffectSizeDataFrame` for deltas' g, its confidence interval, and relevant statistics, for all comparisons as indicated via the `idx` and `paired` argument in `dabest.load()`.\n",
355+
" \"\"\"\n",
356+
" raise DeprecationWarning(\"delta_g has been depreciated - Please use hedges_g (with delta2=True) for deltas' g experiments\")\n",
357+
"\n",
358+
"\n",
350359
" @property\n",
351360
" def input_data(self):\n",
352361
" \"\"\"\n",

0 commit comments

Comments
 (0)