Skip to content

ENH: add _repr_html_ method in the classes Info and BaseRaw#9161

Merged
larsoner merged 14 commits intomne-tools:mainfrom
vagechirkov:add-info-reprt_html-method
Mar 19, 2021
Merged

ENH: add _repr_html_ method in the classes Info and BaseRaw#9161
larsoner merged 14 commits intomne-tools:mainfrom
vagechirkov:add-info-reprt_html-method

Conversation

@vagechirkov
Copy link
Copy Markdown
Contributor

@vagechirkov vagechirkov commented Mar 19, 2021 •
edited
Loading

Reference issue #6846.

Reuse report.py code in order to produce html reports within the Info class.

Here is the output of in the IPython notebook:

image

agramfort
agramfort reviewed Mar 19, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@agramfort agramfort left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so far so good !

larsoner
larsoner reviewed Mar 19, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@larsoner larsoner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you modify tutorials/intro/plot_30_info.py to have a line like:

info

at the end of a code block? Then CircleCI will render it and we'll get to see the _repr_html_ in the built doc of this PR

@vagechirkov
Copy link
Copy Markdown
Contributor Author

vagechirkov commented Mar 19, 2021 •
edited
Loading

Here is the output in the IPython notebook:

image
image

drammock
drammock approved these changes Mar 19, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@drammock drammock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just two tiny bits of Python2 cruft. This looks great!

@drammock
Copy link
Copy Markdown
Member

drammock commented Mar 19, 2021

Here's the CircleCI rendering: https://26281-1301584-gh.circle-artifacts.com/0/dev/auto_tutorials/intro/plot_30_info.html#dropping-channels-from-an-info-object

vagechirkov and others added 2 commits March 19, 2021 18:37
@vagechirkov @drammock
Update mne/data/html_templates.py
0ed305c 
Co-authored-by: Daniel McCloy <dan@mccloy.info>
@vagechirkov @drammock
Update mne/data/html_templates.py
408bd4b 
Co-authored-by: Daniel McCloy <dan@mccloy.info>
@drammock
Copy link
Copy Markdown
Member

drammock commented Mar 19, 2021

@vagechirkov can you mark this as "ready for review"? Or are you still considering it as a draft?

@vagechirkov vagechirkov marked this pull request as ready for review March 19, 2021 17:57
@vagechirkov vagechirkov changed the title WIP ENH: add _repr_html method to the class Info ENH: add _repr_html_ method to the class Info Mar 19, 2021
@vagechirkov vagechirkov changed the title ENH: add _repr_html_ method to the class Info ENH: add _repr_html_ method in the classes Info and BaseRaw Mar 19, 2021
@larsoner larsoner merged commit bc78db5 into mne-tools:main Mar 19, 2021
@larsoner
Copy link
Copy Markdown
Member

larsoner commented Mar 19, 2021

Awesome, thanks @vagechirkov !

@agramfort
Copy link
Copy Markdown
Member

agramfort commented Mar 20, 2021

thx heaps @vagechirkov !

a few suggestions to go further. You see that for raw in the report you only show the info from raw. I think
should show show more. Typically the duration of the recording. Also maybe the files it corresponds to (raw._filenames attribute).

other thoughts anyone?

This was referenced Mar 20, 2021
Merged
Closed
@drammock drammock mentioned this pull request Jun 15, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agramfort agramfort agramfort left review comments

@larsoner larsoner larsoner left review comments

@drammock drammock drammock approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vagechirkov @drammock @larsoner @agramfort