yasa.SleepStatsAgreement.summary

SleepStatsAgreement.summary(ci_method='auto')

Return a DataFrame that includes all calculated metrics:

• Parametric bias

• Parametric lower and upper limits of agreement

• Regression intercept and slope for modeled bias

• Regression intercept and slope for modeled limits of agreement

• Lower and upper confidence intervals for all metrics

Parameters:

ci_methodstr

If 'parm' (i.e., parametric), confidence intervals are always represented using a standard t-distribution. If 'boot' (i.e., bootstrap), confidence intervals are always represented using a bootstrap resampling procedure. If 'auto' (default), confidence intervals are represented using a bootstrap resampling procedure for sleep statistics where the distribution of score differences is non-normal and using a standard t-distribution otherwise.

Returns:

summarypandas.DataFrame

A DataFrame of numeric bias, limits of agreement, and their confidence intervals for all sleep statistics. Columns form a MultiIndex with levels variable and interval ('center', 'lower', 'upper').