nimare.meta.ibma
.WeightedLeastSquares
- class WeightedLeastSquares(tau2=0, **kwargs)[source]
Bases:
IBMAEstimator
Weighted least-squares meta-regression.
Changed in version 0.0.12:
Add “se” to outputs.
Changed in version 0.0.8:
[FIX] Remove single-dimensional entries of each array of returns (
dict
).
New in version 0.0.4.
Provides the weighted least-squares estimate of the fixed effects given known/assumed between-study variance tau^2. When tau^2 = 0 (default), the model is the standard inverse-weighted fixed-effects meta-regression.
This method was described in Brockwell and Gordon[1].
- Parameters:
tau2 (
float
or 1Dnumpy.ndarray
, optional) – Assumed/known value of tau^2. Must be >= 0. Default is 0.
Notes
Requires beta and varcope images.
fit()
produces aMetaResult
object with the following maps:“z”
Z-statistic map from one-sample test.
“p”
P-value map from one-sample test.
“est”
Fixed effects estimate for intercept test.
“se”
Standard error of fixed effects estimate.
Warning
Masking approaches which average across voxels (e.g., NiftiLabelsMaskers) will likely result in biased results. The extent of this bias is currently unknown.
All image-based meta-analysis estimators adopt an aggressive masking strategy, in which any voxels with a value of zero in any of the input maps will be removed from the analysis.
References
See also
pymare.estimators.WeightedLeastSquares
The PyMARE estimator called by this class.
Methods
fit
(dataset[, drop_invalid])Fit Estimator to Dataset.
get_params
([deep])Get parameters for this estimator.
load
(filename[, compressed])Load a pickled class instance from file.
save
(filename[, compress])Pickle the class instance to the provided file.
set_params
(**params)Set the parameters of this estimator.
- fit(dataset, drop_invalid=True)[source]
Fit Estimator to Dataset.
- Parameters:
- Returns:
Results of Estimator fitting.
- Return type:
- Variables:
inputs (
dict
) – Inputs used in _fit.
- classmethod load(filename, compressed=True)[source]
Load a pickled class instance from file.
- Parameters:
- Returns:
obj – Loaded class object.
- Return type:
class object
- set_params(**params)[source]
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form
<component>__<parameter>
so that it’s possible to update each component of a nested object.- Return type:
self