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

Standardize footer of reports #4300

Open
Remi-Gau opened this issue Feb 29, 2024 · 11 comments · May be fixed by #4307
Open

Standardize footer of reports #4300

Remi-Gau opened this issue Feb 29, 2024 · 11 comments · May be fixed by #4307
Assignees
Labels

Comments

@Remi-Gau
Copy link
Collaborator

The GLM reports mention Nilearn and links to the repo.

This should be extended to all reports

image

@emdupre
Copy link
Member

emdupre commented Mar 1, 2024

Does it make sense to extend it to all reports ? For the standalone HTML pages, I could see the need, but would you also add it e.g., to a jupyter cell output of a NiftiMasker report ? In the latter case, I don't think we'd want a footer.

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 3, 2024

In the latter case, I don't think we'd want a footer.

Can you tell me more about why you'd think it'd be an issue if the report in that cell output had a footer?

@emdupre
Copy link
Member

emdupre commented Mar 4, 2024

The standalone HTML reports were designed to be distributed independently, but the within-jupyter calls will be distributed within a notebook (by definition) that will also contain the originating code.

So, in the case of standalone pages, the footer will help to keep provenance --- which is great, I think ! But in the within-jupyter case, it's at best redundant and at worst distracting for those working in a notebook.

@Remi-Gau Remi-Gau linked a pull request Mar 4, 2024 that will close this issue
@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 4, 2024

Note that the PR #4307 was extracted from #4295 to not block the latter until this discussion is resolved.

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 4, 2024

@emdupre
This convo makes me realize that we may want to have some code to run some notebook to check that the reports still look good in a notebook.
Maybe as a follow up to #4295

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 4, 2024

OK I just checked a couple of reports in a notebook and there would some fixing to do (will open a separate issue) but I'd rather get to this once:

  • HTML / CSS is auto-formated
  • refactored across reports for avoid copy pasting the same fixes in 4 different places.

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 4, 2024

To check how reports look (as of #4295) I created this notebook.

https://github.com/Remi-Gau/nilearn/blob/notebooks/doc/visual_testing/visualize_reports_in_notebook.ipynb

Apparently the images cannot be viewed in the github file browser so it needs to be downloaded to view them.

For this discussion:
I am not finding the footer of the GLM reports too distracting at the moment, so I am still mildly inclined to have them everywhere.

More complicated but could maybe look on how to hide the footer in notebooks only but not sure how to best do this (maybe some css magic).

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 4, 2024

Related to improving how reports looks in notebooks:

  • GLM reports
    • different styling as the masker reports
    • too wide and the color bar is hidden on the right of the contrast plots
  • Masker reports
    • why are the maskers reports so narrow by default?

@bthirion
Copy link
Member

bthirion commented Mar 4, 2024

When I download the nb I can't see the report...

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Mar 4, 2024

Hum... I must have messed something. Will check tomorrow.

@bthirion
Copy link
Member

bthirion commented Mar 4, 2024

  • why are the maskers reports so narrow by default?

No idea. These reports were probably a bit minimalist at the origin, hence a narrow layout would be OK.

@Remi-Gau Remi-Gau self-assigned this Apr 9, 2024
@Remi-Gau Remi-Gau added this to the Release 0.11.0 milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants