`pymare.results`.PermutationTestResults

class PermutationTestResults(results, perm_p, n_perm, exact=False)[source]

Lightweight container to hold and display permutation test results.

to_df(**kwargs)[source]

Export permutation test results as a pandas DF.

Parameters:: **kwargs – Keyword arguments to pass onto to_df() calls of parent results class (e.g., in case of MetaRegressionResults class, alpha is available).
Returns:: A pandas DataFrame that adds columns to the standard fixed effect result table based on permutation test results. A column is added for every name found in both the parent DF and the params dictionary passed at initialization.
Return type:: pandas.DataFrame

Examples using `pymare.results.PermutationTestResults`