API Reference
HTML Grid Layouts
⭐ Create multi-figure HTML dashboards with grid and tabbed layouts
| create_plotly_grid_html | Compose multiple Plotly figures into a single HTML file with grid layout. |
| create_tabbed_plotly_grid_html | Create multi-tab HTML dashboard with custom grid layout per tab. |
Multi-line Plotting
⭐ Advanced line plots with statistical overlays and significance testing
| multiline_plot | Create line plot with multiple groups and optional statistical overlays. |
Statistical Testing
⭐ Add statistical significance indicators and model fits to plots
| add_cluster_permut_sig_to_plotly | Add cluster-based permutation test significance indicators to time series plot. |
| add_statsmodel_fit | Add statistical model fit with confidence intervals to Plotly figure. |
| add_box_significance_indicator | Add statistical significance indicators between box or violin plots. |
Plot Enhancements
⭐ Add metadata and utility functions for enhanced plots
| add_meta_info | Adds a metadata info symbol ‘ⓘ’ to a Plotly figure. |
| hex_to_rgba | Convert hex color code to RGBA string format. |
| format_float_to_text_with_suffix | Format a float with metric suffix and up to 2 decimal places. |
Time Series Plotting
Time series visualization with optional resampling
| plot_ts | Plot one or multiple time series with optional resampling. |
| DataShapeError | Exception raised when data has incompatible shape for plotting. |
Plotly Templates
Custom styling templates
| set_template | Set custom Plotly template with default styling for box and violin plots. |
ML Plotting
Machine learning visualizations
| plot_roc_curve | Plot ROC (Receiver Operating Characteristic) curve with AUC. |
MNE Plotting
⭐ Interactive EEG/MEG visualization with topoplots and ERPs
| plot_evoked | Create interactive evoked response plot with optional topoplots. |
| plot_topo | Plot a topoplot from data and an mne instance for meta data information. |
MNE Events
MNE event mapping utilities
| inverse_map_events | Inverse map of events in evid -> use numbers in evid values if present |
MNE Data Conversion
⭐ Convert MNE Raw and Epochs to Polars DataFrames
| mne_raw_to_polars | Convert MNE Raw object to Polars DataFrame. |
| mne_epochs_to_polars | Convert MNE Epochs object to Polars DataFrame. |
Type Converters
Type conversion utilities
| ToFloatConverter | Conversion from numpy array of various data formats to float and back |