Skip to content

Commit a33c140

Browse files
authored
[DOC] Warn users about Peaks2MapsKernel and KDA Estimator (#420)
* Add warning to Peaks2MapsKernel. * Add warning to KDA estimator. * Update nimare/meta/cbma/mkda.py * Fix KDA warning.
1 parent acaa849 commit a33c140

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

nimare/meta/cbma/mkda.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,12 @@ class KDA(CBMAEstimator):
462462
463463
Available correction methods: :func:`KDA.correct_fwe_montecarlo`
464464
465+
Warning
466+
-------
467+
The KDA algorithm has been replaced in the literature with the MKDA algorithm.
468+
As such, this estimator should almost never be used, outside of systematic
469+
comparisons between algorithms.
470+
465471
References
466472
----------
467473
.. [1] Wager, Tor D., et al. "Valence, gender, and lateralization of
@@ -476,6 +482,12 @@ class KDA(CBMAEstimator):
476482
def __init__(
477483
self, kernel_transformer=KDAKernel, null_method="empirical", n_iters=10000, **kwargs
478484
):
485+
LGR.warning(
486+
"The KDA algorithm has been replaced in the literature with the MKDA algorithm. "
487+
"As such, this estimator should almost never be used, outside of systematic "
488+
"comparisons between algorithms."
489+
)
490+
479491
if not (isinstance(kernel_transformer, KDAKernel) or kernel_transformer == KDAKernel):
480492
LGR.warning(
481493
f"The KernelTransformer being used ({kernel_transformer}) is not optimized "

nimare/meta/kernel.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,12 +319,21 @@ class Peaks2MapsKernel(KernelTransformer):
319319
resample_to_mask : :obj:`bool`, optional
320320
If True, will resample the MA maps to the mask's header.
321321
Default is True.
322+
323+
Warning
324+
-------
325+
Peaks2MapsKernel is not intended for serious research.
326+
We strongly recommend against using it for any meaningful analyses.
322327
"""
323328

324329
def __init__(self, model_dir="auto"):
325330
# Use private attribute to hide value from get_params.
326331
# get_params will find model_dir=None, which is *very important* when a path is provided.
327332
self._model_dir = model_dir
333+
LGR.warning(
334+
"The Peaks2Maps kernel transformer is not intended for serious research. "
335+
"We strongly recommend against using it for any meaningful analyses."
336+
)
328337

329338
def _transform(self, mask, coordinates):
330339
transformed = []

0 commit comments

Comments
 (0)