Add tinyplot methods #731
Add tinyplot methods #731
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @strengejacke, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the plotting functionality by integrating estimate_density objects with the tinyplot package. It provides a streamlined way to visualize the estimated distributions of model parameters, offering clear insights into their central tendencies and uncertainties through ridge plots and error bars. This improves the interpretability and presentation of statistical model outputs.
Highlights
- New Plotting Method: Introduced
tinyplot.estimate_density, an S3 method that extends thetinyplotpackage's capabilities to visualizeestimate_densityobjects. - Density Visualization: The new method generates ridge plots to display the distribution of parameters, along with point estimates (median by default) and confidence intervals (95% by default).
- Intercept Handling: Added utility functions (
.intercept_names,.is_intercept,.remove_intercept) to allow for optional exclusion of intercept terms from the plots, improving focus on other parameters.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new tinyplot method for estimate_density objects, which facilitates the creation of ridge-style plots for posterior densities, complete with credibility intervals. The core logic is well-structured within the new R/tinyplot.R file. My review focuses on enhancing code clarity and maintainability by suggesting the removal of an unused function argument, deleting commented-out code, and simplifying a regular expression by removing a redundant flag. Overall, this is a valuable addition to the package's plotting capabilities.
| @@ -0,0 +1,99 @@ | |||
| #' @exportS3Method tinyplot::tinyplot | |||
| tinyplot.estimate_density <- function(x, centrality = "median", ci = 0.95, show_intercept = FALSE, ...) { | |||
There was a problem hiding this comment.
The ... argument is defined in the function signature but it is not used anywhere within the function. This can be misleading for users of the function who might expect to be able to pass additional arguments to underlying functions. If it's not used, it should be removed to improve clarity.
tinyplot.estimate_density <- function(x, centrality = "median", ci = 0.95, show_intercept = FALSE) {
R/tinyplot.R
Outdated
| # my_summary$Parameter <- factor( | ||
| # my_summary$Parameter, | ||
| # levels = levels(my_summary$Parameter) | ||
| # ) |
There was a problem hiding this comment.
This block of code is commented out. Dead code like this should be removed to improve the readability and maintainability of the codebase.
|
|
||
| .is_intercept <- function(x) { | ||
| x <- tolower(x) | ||
| x %in% .intercept_names | grepl("(?i)intercept[^a-zA-Z]", x) |
There was a problem hiding this comment.
The input x is converted to lowercase on the preceding line (x <- tolower(x)). Therefore, the case-insensitive flag (?i) in the grepl call is redundant. Removing it will make the code slightly cleaner and avoid potential confusion.
x %in% .intercept_names | grepl("intercept[^a-zA-Z]", x)
No description provided.