nimare.correct.FWECorrector
- class FWECorrector(method='bonferroni', **kwargs)[source]
Bases:
nimare.correct.CorrectorPerform family-wise error rate correction on a meta-analysis.
- Parameters
method (
str) – The FWE correction to use. Available internal methods are ‘bonferroni’. Additional methods may be implemented within the provided Estimator.**kwargs – Keyword arguments to be used by the FWE correction implementation.
Notes
This corrector supports a small number of internal FWE correction methods, but can also use special methods implemented within individual Estimators. To determine what methods are available for the Estimator you’re using, check the Estimator’s documentation. Estimators have special methods following the naming convention correct_[correction-type]_[method] (e.g.,
nimare.meta.ale.ALE.correct_fwe_montecarlo()).- classmethod inspect(result)[source]
Identify valid ‘method’ values for a MetaResult object.
- Parameters
result (
nimare.results.MetaResult) – Object for which valid correction methods (i.e., ‘method’ values) will be identified.- Returns
list– List of valid ‘method’ values for the Corrector+Estimator combination, including both non-specific methods and Estimator-specific ones.
- transform(result)[source]
Apply the multiple comparisons correction method to a MetaResult object.
- Parameters
result (
nimare.results.MetaResult) – MetaResult generated by an Estimator to be corrected for multiple comparisons.- Returns
result (
nimare.results.MetaResult) – MetaResult with new corrected maps added.
