Skip to content

Commit 1801e86

Browse files
1himandrammock
andauthored
Improve docs for raw.to_data_frame (mne-tools#13590)
Co-authored-by: Daniel McCloy <dan@mccloy.info>
1 parent 7e357df commit 1801e86

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

mne/io/base.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2429,6 +2429,10 @@ def to_data_frame(
24292429
additional column "time" is added, unless ``index`` is not ``None``
24302430
(in which case time values form the DataFrame's index).
24312431
2432+
.. attention:: By default, returned data values are scaled from
2433+
SI units to a unit more suitable for plotting or statistical modeling.
2434+
See the description of the ``scalings`` parameter for details.
2435+
24322436
Parameters
24332437
----------
24342438
%(picks_all)s

mne/utils/docs.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3982,7 +3982,8 @@ def _reflow_param_docstring(docstring, has_first_line=True, width=75):
39823982
scalings : dict | None
39833983
Scaling factor applied to the channels picked. If ``None``, defaults to
39843984
``dict(eeg=1e6, mag=1e15, grad=1e13)`` — i.e., converts EEG to µV,
3985-
magnetometers to fT, and gradiometers to fT/cm.
3985+
magnetometers to fT, and gradiometers to fT/cm. See :term:`data channels`
3986+
and :term:`non-data channels` for full list of default scalings.
39863987
"""
39873988

39883989
docdict["scalings_topomap"] = """

0 commit comments

Comments
 (0)