Skip to content

Commit 83456bf

Browse files
committed
Added top-level docstring
1 parent 46c3cef commit 83456bf

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

src/yasa/evaluation.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1611,7 +1611,17 @@ def plot_blandaltman(
16111611
scatter_kwargs=None,
16121612
**kwargs,
16131613
):
1614-
"""
1614+
"""Plot Bland-Altman agreement plots for one or more sleep statistics.
1615+
1616+
Each panel shows observed-minus-reference differences (y-axis) against reference values
1617+
(x-axis) for one sleep statistic. Bias and limits of agreement are drawn as lines, with
1618+
optional confidence-interval bands. Methods (parametric, regression, or bootstrap) are
1619+
chosen automatically per statistic based on the assumption tests stored in
1620+
:py:attr:`~yasa.SleepStatsAgreement.assumptions`, or can be set explicitly.
1621+
1622+
.. seealso:: :py:meth:`~yasa.SleepStatsAgreement.report`,
1623+
:py:meth:`~yasa.SleepStatsAgreement.summary`
1624+
16151625
Parameters
16161626
----------
16171627
sleep_stats : list or None

0 commit comments

Comments
 (0)