8000 ENH: Improve report usability (#12901) · tsbinns/mne-python@56e522b · GitHub
[go: up one dir, main page]
Skip to content

Commit 56e522b

Browse files
larsonerautofix-ci[bot]drammock
authored
ENH: Improve report usability (mne-tools#12901)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info>
1 parent f35aa5a commit 56e522b

File tree

13 files changed

+510
-186
lines changed

13 files changed

+510
-186
lines changed

‎doc/changes/devel/12901.bugfix.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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`_.

‎doc/changes/devel/12901.newfeature.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Improved reporting and plotting options:
2+
3+
- :meth:`mne.Report.add_projs` can now plot with :func:`mne.viz.plot_projs_joint` rather than :func:`mne.viz.plot_projs_topomap`
4+
- :class:`mne.Report` now has attributes ``img_max_width`` and ``img_max_res`` that can be used to control image scaling.
5+
- :class:`mne.Report` now has an attribute ``collapse`` that allows collapsing sections and/or subsections by default.
6+
- :func:`mne.viz.plot_head_positions` now has a ``totals=True`` option to show the total distance and angle of the head.
7+
8+
Changes by `Eric Larson`_.

‎mne/html_templates/report/html.html.jinja

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<div class="accordion-item {{ div_klass }}" id="{{ id }}" data-mne-tags="{% for tag in tags %} {{ tag }} {% endfor %}">
22
<div class="accordion-header" id="accordion-header-{{id}}">
3-
<button class="accordion-button pt-1 pb-1" type="button" data-bs-toggle="collapse"
4-
data-bs-target="#accordion-collapse-{{ id }}" aria-expanded="true" aria-controls="accordion-collapse-{{id}}">
3+
<button class="accordion-button pt-1 pb-1" type="button" data-bs-toggle="collapse" data-bs-target="#accordion-collapse-{{ id }}" aria-expanded="true" aria-controls="accordion-collapse-{{id}}">
54
<div class="w-100">
65
<span class="me-auto"><a href="#{{ id }}" class="text-decoration-none">{{ title }}</a></span>
76
{% for tag in tags %}
@@ -12,10 +11,7 @@
1211
</div>
1312
</button>
1413
</div>
15-
16-
17-
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse show"
18-
aria-labelledby="accordion-header-{{ id }}">
14+
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse {{ show }}" aria-labelledby="accordion-header-{{ id }}">
1915
<div class="accordion-body">
2016
{{ html | safe }}
2117
</div>

‎mne/html_templates/report/image.html.jinja

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{% extends "section.html.jinja" %}
22
{% block html_content %}
3-
<figure class="figure mx-auto d-block">
4-
{% if image_format == 'svg' %}
5-
<div class="d-flex justify-content-center">
6-
{{ img|safe }}
7-
</div>
8-
{% else %}
9-
<img class="figure-img img-fluid rounded mx-auto my-0 d-block" alt="{{ title }}"
10-
src="data:image/{{ image_format }};base64,{{ img }}">
11-
{% endif %}
3+
<figure class="figure mx-auto d-block">
4+
{% if image_format == 'svg' %}
5+
<div class="d-flex justify-content-center">
6+
{{ img|safe }}
7+
</div>
8+
{% else %}
9+
<img class="figure-img img-fluid rounded mx-auto my-0 d-block" alt="{{ title }}"
10+
src="data:image/{{ image_format }};base64,{{ img }}">
11+
{% endif %}
1212

13-
{% if caption is not none %}
14-
<figcaption class="figure-caption text-center">{{ caption }}</figcaption>
15-
{% endif %}
16-
</figure>
13+
{% if caption is not none %}
14+
<figcaption class="figure-caption text-center">{{ caption }}</figcaption>
15+
{% endif %}
16+
</figure>
1717
{% endblock html_content %}

‎mne/html_templates/report/section.html.jinja

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<div class="accordion-item {{ div_klass }}" id="{{ id }}" data-mne-tags="{% for tag in tags %} {{ tag }} {% endfor %}">
22
<div class="accordion-header" id="accordion-header-{{id}}">
3-
<button class="accordion-button pt-1 pb-1" type="button" data-bs-toggle="collapse"
4-
data-bs-target="#accordion-collapse-{{ id }}" aria-expanded="true" aria-controls="accordion-collapse-{{id}}">
3+
<button class="accordion-button pt-1 pb-1" type="button" data-bs-toggle="collapse" data-bs-target="#accordion-collapse-{{ id }}" aria-expanded="true" aria-controls="accordion-collapse-{{id}}">
54
<div class="w-100">
65
<span class="me-auto"><a href="#{{ id }}" class="text-decoration-none">{{ title }}</a></span>
76
{% for tag in tags %}
@@ -12,10 +11,7 @@
1211
</div>
1312
</button>
1413
</div>
15-
16-
17-
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse show"
18-
aria-labelledby="accordion-header-{{ id }}">
14+
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse {{ show }}" aria-labelledby="accordion-header-{{ id }}">
1915
<div class="accordion-body">
2016
{% block html_content %}
2117
{% for html in htmls %}

‎mne/html_templates/report/slider.html.jinja

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
<div class="accordion-item slider {{ klass }}" id="{{ id }}"
22
data-mne-tags="{% for tag in tags %} {{ tag }} {% endfor %}">
33
<div class="accordion-header" id="accordion-header-{{ id }}">
4-
<button class="accordion-button pt-1 pb-1" type="button" data-bs-toggle="collapse"
5-
data-bs-target="#accordion-collapse-{{ id }}" aria-expanded="true" aria-controls="accordion-collapse-{{ id }}">
4+
<button class="accordion-button pt-1 pb-1" type="button" data-bs-toggle="collapse" data-bs-target="#accordion-collapse-{{ id }}" aria-expanded="true" aria-controls="accordion-collapse-{{ id }}">
65
<div class="w-100">
76
<span class="me-auto"><a href="#{{ id }}" class="text-decoration-none">{{ title }}</a></span>
87
{% for tag in tags %}
@@ -13,9 +12,7 @@
1312
</div>
1413
</button>
1514
</div>
16-
17-
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse show"
18-
aria-labelledby="accordion-header-{{ id }}">
15+
<div id="accordion-collapse-{{ id }}" class="accordion-collapse collapse {{ show }}" aria-labelledby="accordion-header-{{ id }}">
1916
<div class=" accordion-body">
2017
<div class="mx-auto d-block w-75">
2118
<label for="slider-{{ id }}" class="form-label small">
@@ -24,9 +21,7 @@
2421
<input type="range" class="form-range" min="0" max="{{ images|length - 1 }}" value="{{ start_idx }}"
2522
id="slider-{{id}}">
2623
</div>
27-
28-
<div id="corousel-{{ id }}" class="carousel carousel-dark" data-bs-interval="false" data-bs-wrap="false"
29-
data-bs-keyboard="true">
24+
<div id="corousel-{{ id }}" class="carousel carousel-dark" data-bs-interval="false" data-bs-wrap="false" data-bs-keyboard="true">
3025
<div class="carousel-inner">
3126
{% for idx, img, caption in range(images|length)|zip(images, captions) %}
3227
<div class="carousel-item {% if idx == start_idx %}active{% endif %}">
@@ -40,7 +35,6 @@
4035
</div>
4136
{% endfor %}
4237
</div>
43-
4438
{# <button class="carousel-control-prev" type="button" data-bs-target="#corousel-{{id}}" data-bs-slide="prev">
4539
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
4640
<span class="visually-hidden">Previous</span>

0 commit comments

Comments
 (0)
0