-
Notifications
You must be signed in to change notification settings - Fork 7
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
Conversation
* Don't use deprecated `Problem.from_files` * Simplify by not loading all files separately * Fix grammar / typos * Add replicate plot example
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
"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", |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
Co-authored-by: Maren Philipps <55318391+m-philipps@users.noreply.github.com>
The visualization examples were pretty redundant. Merged them into a single notebook. Removed redundant blocks.
Furthermore:
Problem.from_files
👀 https://petab--236.org.readthedocs.build/projects/libpetab-python/en/236/example/example_visualization.html#