pylint fixes and renamed n_obs to n_res to avoid confusion
@@ -17,10 +17,11 @@ def cov_from_residuals(residuals, dof=None):
estimator for large-dimensional covariance matrices"
Args:
- residuals(numpy.ndarray or list of these): n_obs x n_channels matrix
- of residuals
+ residuals(numpy.ndarray or list of these): n_residuals x n_channels
+ matrix of residuals
dof(int or list of int): degrees of freedom for covariance estimation
- defaults to n_obs-1, should be corrected for
+ defaults to n_res - 1, should be corrected for the number
+ of regressors in a GLM if applicable.
Returns:
numpy.ndarray (or list): sigma_p: covariance matrix over channels
@@ -58,10 +59,11 @@ def prec_from_residuals(residuals, dof=None):
estimator for large-dimensional covariance matrices"
Args:
- residuals(numpy.ndarray or list of these): n_obs x n_channels matrix
- of residuals
+ residuals(numpy.ndarray or list of these): n_residuals x n_channels
+ matrix of residuals
dof(int or list of int): degrees of freedom for covariance estimation
- defaults to n_obs-1, should be corrected for
+ defaults to n_res - 1, should be corrected for the number
+ of regressors in a GLM if applicable.
Returns:
numpy.ndarray (or list): sigma_p: covariance matrix over channels
