nimare.correct
.FDRCorrector
- class FDRCorrector(alpha=0.05, method='indep', **kwargs)[source]
Bases:
nimare.correct.Corrector
Perform false discovery rate correction on a meta-analysis.
- Parameters
Notes
This corrector supports a small number of internal FDR 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.,
correct_fdr_bh
).Methods
inspect
(result)Identify valid 'method' values for a MetaResult object.
transform
(result)Apply the multiple comparisons correction method to a MetaResult object.
- classmethod inspect(result)[source]
Identify valid ‘method’ values for a MetaResult object.
- Parameters
result (
MetaResult
) – Object for which valid correction methods (i.e., ‘method’ values) will be identified.- Returns
List of valid ‘method’ values for the Corrector+Estimator combination, including both non-specific methods and Estimator-specific ones.
- Return type
- transform(result)[source]
Apply the multiple comparisons correction method to a MetaResult object.
- Parameters
result (
MetaResult
) – MetaResult generated by an Estimator to be corrected for multiple comparisons.- Returns
result – MetaResult with new corrected maps added.
- Return type