Skip to content

Commit 47d26ec

Browse files
When rendering Evoked in a Report, now also include an "Info" section containing the HTML repr (#12584)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 0b19084 commit 47d26ec

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
When adding :class:`~mne.Evoked` data to a :class:`~mne.Report` via
2+
:meth:`~mne.Report.add_evokeds`, we now also include an "Info" section
3+
with some basic summary info, as has already been the case for raw and
4+
epochs data, by `Richard Höchenberger`_.

mne/report/report.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3672,6 +3672,17 @@ def _add_evoked(
36723672
n_jobs,
36733673
replace,
36743674
):
3675+
# Summary table
3676+
self._add_html_repr(
3677+
inst=evoked,
3678+
title="Info",
3679+
tags=tags,
3680+
section=section,
3681+
replace=replace,
3682+
div_klass="evoked",
3683+
)
3684+
3685+
# Joint plot
36753686
ch_types = _get_data_ch_types(evoked)
36763687
self._add_evoked_joint(
36773688
evoked=evoked,
@@ -3682,6 +3693,8 @@ def _add_evoked(
36823693
topomap_kwargs=topomap_kwargs,
36833694
replace=replace,
36843695
)
3696+
3697+
# Topomaps
36853698
self._add_evoked_topomap_slider(
36863699
evoked=evoked,
36873700
ch_types=ch_types,
@@ -3693,6 +3706,8 @@ def _add_evoked(
36933706
n_jobs=n_jobs,
36943707
replace=replace,
36953708
)
3709+
3710+
# GFP
36963711
self._add_evoked_gfp(
36973712
evoked=evoked,
36983713
ch_types=ch_types,
@@ -3702,6 +3717,7 @@ def _add_evoked(
37023717
replace=replace,
37033718
)
37043719

3720+
# Whitened evoked
37053721
if noise_cov is not None:
37063722
self._add_evoked_whitened(
37073723
evoked=evoked,

tutorials/intro/70_report.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@
156156
# noise covariance, we can add plots evokeds that were "whitened" using this
157157
# covariance matrix.
158158
#
159-
# By default, this method will produce snapshots at 21 equally-spaced time
159+
# By default, this method will produce topographic plots at 21 equally-spaced time
160160
# points (or fewer, if the data contains fewer time points). We can adjust this
161161
# via the ``n_time_points`` parameter.
162162

0 commit comments

Comments
 (0)