summarize_pvalue_significance#
- mlproject.plotting.distance_correlation.summarize_pvalue_significance(pvals, significance_func=significance_stars)[source]#
Summarize p-value significance across a matrix for plot title.
If all cells have the same significance level, returns a summary like ‘all cells: p < 0.01’. Otherwise, returns the legend mapping for significance stars.
- Parameters:
pvals (pd.DataFrame) – Matrix of p-values.
significance_func (callable, optional) – Function mapping a p-value to a significance start string.
- Returns:
A summary of p-value significance.
- Return type:
str