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

Doc: Clean up visualization examples #236

Merged
merged 10 commits into from
Dec 18, 2023
Merged

Doc: Clean up visualization examples #236

merged 10 commits into from
Dec 18, 2023

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Dec 15, 2023

The visualization examples were pretty redundant. Merged them into a single notebook. Removed redundant blocks.

Furthermore:

  • Don't use deprecated Problem.from_files
  • Simplify by not loading all files separately
  • Fix grammar / typos
  • Add replicate plot example
  • Make plots more readable
  • ...

👀 https://petab--236.org.readthedocs.build/projects/libpetab-python/en/236/example/example_visualization.html#

* Don't use deprecated `Problem.from_files`
* Simplify by not loading all files separately
* Fix grammar / typos
* Add replicate plot example
@codecov-commenter
Copy link

codecov-commenter commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1bebd15) 76.30% compared to head (e292d2d) 76.30%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #236   +/-   ##
========================================
  Coverage    76.30%   76.30%           
========================================
  Files           34       34           
  Lines         3191     3191           
  Branches       774      774           
========================================
  Hits          2435     2435           
  Misses         554      554           
  Partials       202      202           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

"outputs": [],
"source": [
"simu_file_Fujita = \"example_Fujita/Fujita_simulatedData.tsv\"\n",
"petab_problem = Problem.from_yaml(petab_yaml_isensee)\n",
"petab_problem.visualization_df = petab.get_visualization_df(\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you think it is useful to show the visualisation df here as well?

Copy link
Member Author

Choose a reason for hiding this comment

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

Stating what changed should be sufficient.
Not sure if the long tables improve the reading experience.

Out of scope here, but at some point, this should be changed to always just showing 1-2 plots with a clear objective and fewer distractions.

Copy link
Collaborator

Choose a reason for hiding this comment

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

In that case we could just remove subplots 3 and 4.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added a comment on what changed. Should be okay for now.

Copy link
Collaborator

@m-philipps m-philipps left a comment

Choose a reason for hiding this comment

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

Looks great, thank you.
The use of plot in/on is not always consistent.

dweindl and others added 2 commits December 18, 2023 09:40
Co-authored-by: Maren Philipps <55318391+m-philipps@users.noreply.github.com>
@dweindl dweindl removed the request for review from plakrisenko December 18, 2023 08:47
@dweindl dweindl requested a review from plakrisenko as a code owner December 18, 2023 08:59
@dweindl dweindl merged commit d2db5ba into develop Dec 18, 2023
7 checks passed
@dweindl dweindl deleted the doc_nb branch December 18, 2023 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants