Skip to content

Commit c3ecfd2

Browse files
DOC: address review - add sensor-space detail and citation
1 parent 922c26f commit c3ecfd2

2 files changed

Lines changed: 16 additions & 5 deletions

File tree

doc/references.bib

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2566,3 +2566,13 @@ @inproceedings{MellotEtAl2024
25662566
year = {2024},
25672567
address = {Lyon, France}
25682568
}
2569+
2570+
@article{AppelhoffSanderson2023,
2571+
author = {Appelhoff, Stefan and Sanderson, Nathan},
2572+
title = {The importance of adding a zero-filled channel for the reference electrode when re-referencing to average reference},
2573+
journal = {Frontiers in Signal Processing},
2574+
year = {2023},
2575+
doi = {10.3389/frsip.2023.1064138},
2576+
volume = {3},
2577+
pages = {1064138}
2578+
}

mne/utils/docs.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4104,12 +4104,13 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
41044104
- Average reference:
41054105
A new virtual reference electrode is created by averaging the current
41064106
EEG signal by setting ``ref_channels='average'``. Bad EEG channels are
4107-
automatically excluded if they are properly set in ``info['bads']``.
4107+
automatically excluded if they are pproperly set in ``info['bads']``.
41084108
4109-
.. note::
4110-
If you wish to add a new reference channel (e.g., a mastoid)
4111-
to the data, use :func:`mne.add_reference_channels`
4112-
**before** calling this function.
4109+
"add_reference_channels_note": """.. note:: When performing average referencing in sensor-space analyses and the
4110+
original reference electrode is not present as a zero-filled channel,
4111+
this must first be added using :func:`~mne.add_reference_channels`
4112+
before calling :func:`~mne.set_eeg_reference` to avoid biasing the
4113+
reference :footcite:`AppelhoffSanderson2023`. """,
41134114
41144115
- A single electrode:
41154116
Set ``ref_channels`` to a list containing the name of the channel that

0 commit comments

Comments
 (0)