Source code for neurokit2.stats.mad

# -*- coding: utf-8 -*-
import numpy as np




def mad(x, constant=1.4826, **kwargs):
    """**Median Absolute Deviation: a "robust" version of standard deviation**

    Parameters
    ----------
    x : Union[list, np.array, pd.Series]
        A vector of values.
    constant : float
        Scale factor. Use 1.4826 for results similar to default R.

    Returns
    ----------
    float
        The MAD.

    Examples
    ----------
    .. ipython:: python

      import neurokit2 as nk
      nk.mad([2, 8, 7, 5, 4, 12, 5, 1])


    References
    -----------
    * https://en.wikipedia.org/wiki/Median_absolute_deviation

    """
    median = np.nanmedian(np.ma.array(x).compressed(), **kwargs)
    mad_value = np.nanmedian(np.abs(x - median), **kwargs)
    mad_value = mad_value * constant
    return mad_value