Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Improve report usability #12901

Merged
merged 11 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changes/devel/12901.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:class:`mne.Report` HDF5 files are now written in ``mode='a`` (append) to allow users to store other data in the HDF5 files, by `Eric Larson`_.
larsoner marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 8 additions & 0 deletions doc/changes/devel/12901.newfeature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Improved reporting and plotting options:

- :meth:`mne.Report.add_projs` can now plot with :func:`mne.viz.plot_projs_joint` rather than :func:`mne.viz.plot_projs_topomap`
- :class:`mne.Report` now has attributes ``img_max_width`` and ``img_max_res`` that can be used to control image scaling.
- :class:`mne.Report` now has an attribute ``collapse`` that allows collapsing sections and/or subsections by default.
- :func:`mne.viz.plot_head_positions` now has a ``totals=True`` option to show the total distance and angle of the head.

Changes by `Eric Larson`_.
2 changes: 1 addition & 1 deletion mne/html_templates/report/html.html.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</div>


<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse show"
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse {{ show }}"
aria-labelledby="accordion-header-{{ id }}">
<div class="accordion-body">
{{ html | safe }}
Expand Down
2 changes: 1 addition & 1 deletion mne/html_templates/report/section.html.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</div>


<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse show"
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse {{ show }}"
aria-labelledby="accordion-header-{{ id }}">
<div class="accordion-body">
{% block html_content %}
Expand Down
2 changes: 1 addition & 1 deletion mne/html_templates/report/slider.html.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</button>
</div>

<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse show"
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse {{ show }}"
aria-labelledby="accordion-header-{{ id }}">
<div class=" accordion-body">
<div class="mx-auto d-block w-75">
Expand Down
Loading
Loading