pastas.check.uncertainty_gain
=============================

.. py:function:: pastas.check.uncertainty_gain(ml: pastas.typing.Model, n_std: float = 1.96, names: list[str] | str | None = None)

   
   Check if the gain is larger than n_std times the uncertainty in the gain.

   :param ml: Pastas model instance.
   :type ml: pastas.Model
   :param n_std: Number of standard errors to compare the the gain to. Default is 1.96.
   :type n_std: int, optional
   :param names: List of stressmodel names to check the gain for. Default is None, which
                 means all stressmodels are checked.
   :type names: list or str, optional

   :returns: **df** -- DataFrame with the results of the check.
   :rtype: pandas.DataFrame















   ..
       !! processed by numpydoc !!