Strip by of tokens before attempting removal

[ryanzomorrodi]

Fixes #1156

When removing the random factors, get_datagrid() checks if the random factors are in the by, but if there is a token on the by variable the by variable is removed anyway. A simple fix is to strip the by of tokens before checking.

I copied some code from elsewhere which seems to strip the tokens, but I'm not sure if this is how you want to do things.

[gemini-code-assist]

Summary of Changes

Hello @ryanzomorrodi, I'm Gemini Code Assist¹! 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 addresses a bug in the get_datagrid() function where random factors were erroneously removed if they appeared in the by argument with additional tokens. The solution involves preprocessing the by variables to strip any tokens, ensuring that the comparison with random factors is accurate and prevents unintended data removal. This change improves the robustness of get_datagrid() when handling complex by specifications.

Highlights

• Bug Fix for get_datagrid(): Resolves an issue where get_datagrid() would incorrectly remove random factors when they were specified in the by argument with attached tokens (e.g., variable = [token]).
• Token Stripping Logic: Introduces a new by_stripped variable that cleans tokens from the by argument using .get_datagrid_clean_target() before comparing against random factors.
• Enhanced Test Coverage: Adds a new test_that block to specifically validate the correct behavior of get_datagrid() when by includes tokened random effects.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

[gemini-code-assist]

Code Review

This pull request addresses an issue where random factors specified in by with tokens were not correctly identified and were being dropped. The proposed solution is to strip the tokens from the by variables before checking against the list of random factors. This is a good approach.

However, I've found a critical issue in the implementation. The way the helper function .get_datagrid_clean_target is called will lead to an error due to mismatched arguments. I've provided a specific comment with a suggested fix for this.

I also noticed that the pattern for calling .get_datagrid_clean_target was likely copied from get_datagrid.data.frame, which appears to have the same issue. It would be beneficial to correct that as well, perhaps in a follow-up.

The new test case is well-written and correctly captures the scenario this PR aims to fix. Once the function call is corrected, this PR should effectively resolve the issue.

[strengejacke]

Thanks, I'll run checks and then review your PR.