yasa.SleepStatsAgreement.get_table#

SleepStatsAgreement.get_table(bias_method='auto', loa_method='auto', ci_method='auto', fstrings={})[source]#

Return a DataFrame with bias, loa, bias_ci, loa_ci as string equations.

Parameters:

bias_methodstr: If 'parm' (i.e., parametric), bias is always represented as the mean difference (observed minus reference). If 'regr' (i.e., regression), bias is always represented as a regression equation. If 'auto' (default), bias is represented as a regression equation for sleep statistics where the score differences are proportionally biased and as the mean difference otherwise.
loa_methodstr: If 'parm' (i.e., parametric), limits of agreement are always represented as bias +/- 1.96 standard deviations (where 1.96 can be adjusted through the agreement parameter). If 'regr' (i.e., regression), limits of agreement are always represented as a regression equation. If 'auto' (default), limits of agreement are represented as a regression equation for sleep statistics where the score differences are proportionally biased and as bias +/- 1.96 standard deviation otherwise.
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.
fstringsdict: Optional custom strings for formatting cells.

Returns:

tablepandas.DataFrame: A DataFrame of string representations for bias, limits of agreement, and their confidence intervals for all sleep statistics.