-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add options to plot single FOI estimates and rhats #270
Open
ntorresd
wants to merge
8
commits into
main
Choose a base branch
from
i202-rhats-constant-model
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add tests for: - `validate_plot_constant()` - `plot_summary()` exceptions
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #270 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 1015 1071 +56
=========================================
+ Hits 1015 1071 +56 ☔ View full report in Codecov by Sentry. |
zmcucunuba
approved these changes
Jan 22, 2025
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.
Excellent! Plot approved.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces parameters
plot_constant
andx_axis
to the visualisation functions of the package. These enable the option to plot constant FOI estimates and their corresponding r-hat values, avoiding ambiguity in the specification of the x-axis by means ofx_axis = "time"
orx_axis = "age"
.Currently,
plot_seromodel()
behaves differently for constant models. The single FOI estimate and its corresponging r-hat value are displayed in the summary generated by means ofplot_summary()
, e.g.This is preserved as the default behavior, as we would have to choose arbitrarily to plot either with respect to time or age otherwise. Now, if
plot_model = TRUE
and a constant model is provided, the x-axis can be specified to be either age or time by means ofx_axis
, e.g.Exceptions for other possible scenarios are handled by the new validation function
validate_plot_constant()
. This function stops the process wheneverplot_constant = TRUE
and a non-constant model is provided, or ifx_axis
is not set up properly when intending to plot constant models. Informative error messages are provided in both cases.