Skip to content

Draft inequality vigntte#541

Merged
strengejacke merged 4 commits intomainfrom
draft_inequality_vignette
Jul 25, 2025
Merged

Draft inequality vigntte#541
strengejacke merged 4 commits intomainfrom
draft_inequality_vignette

Conversation

@strengejacke
Copy link
Copy Markdown
Member

No description provided.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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 introduces a significant new piece of documentation in the form of a vignette, aimed at guiding users through the process of measuring and comparing absolute and relative inequalities using the modelbased package. This enhances the package's educational resources by providing a practical case study on a relevant statistical concept.

Highlights

  • New Vignette Addition: I've added a new R Markdown vignette titled 'Case Study: Measuring and comparing absolute and relative inequalities in R'. This vignette provides a detailed guide on how to use the modelbased package to quantify and compare absolute and relative inequalities in statistical models, using a practical example with the qol_cancer dataset.
  • Documentation Integration: The new inequality vignette has been integrated into the package's documentation. This includes adding a new entry to the pkgdown navigation bar and updating the vignettes/overview_of_vignettes.Rmd file to link to the new content, making it easily discoverable for users.
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

  1. 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.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new vignette on measuring and comparing absolute and relative inequalities. I've identified a couple of issues that could lead to broken links on the documentation site, and I've also suggested a minor improvement for consistency within the new vignette file.

- text: "Intersectionality analysis using the MAIHDA framework"
href: articles/practical_intersectionality.html
- text: "Measuring and comparing absolute and relative inequalities"
href: articles/practical_inequality.html
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

high

The href for the new vignette seems to have a typo. The new vignette file is named practical_inequalities.Rmd (plural), but the link points to practical_inequality.html (singular). This will likely result in a broken link on the pkgdown site. Please correct the filename to match the vignette file.

          href: articles/practical_inequalities.html

* [Understanding your models](https://easystats.github.io/modelbased/articles/workflow_modelbased.html)
* [Causal inference for observational data](https://easystats.github.io/modelbased/articles/practical_causality.html)
* [Intersectionality analysis using the MAIHDA framework](https://easystats.github.io/modelbased/articles/practical_intersectionality.html)
* [Measuring and comparing absolute and relative inequalities](https://easystats.github.io/modelbased/articles/practical_inequality.html)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

high

The link to the new vignette appears to be incorrect. The vignette file is practical_inequalities.Rmd, so the generated HTML will be practical_inequalities.html. The link currently points to practical_inequality.html (singular). This will result in a broken link.

* [Measuring and comparing absolute and relative inequalities](https://easystats.github.io/modelbased/articles/practical_inequalities.html)

@strengejacke strengejacke merged commit 5e87b7d into main Jul 25, 2025
23 of 25 checks passed
@strengejacke strengejacke deleted the draft_inequality_vignette branch July 25, 2025 23:35
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.

1 participant