Bf matrix

[mattansb]

• Added as.matrix(<restricted>) method.
• Added docs about BF matrix

[gemini-code-assist]

Summary of Changes

Hello @mattansb, 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 enhances the bayestestR package by introducing a new method to convert restricted Bayes factors into a matrix format, which facilitates direct comparison between different restricted models. It also includes significant documentation updates to clarify the concept of Bayes factor transitivity and refactors the internal printing logic for Bayes factor matrices, leading to a more consistent and user-friendly experience.

Highlights

• New Functionality: Introduced an as.matrix() method for bayesfactor_restricted() objects, allowing users to obtain a matrix of Bayes factors between all restricted models.
• Documentation Enhancement: Added comprehensive documentation regarding the 'Transitivity of Bayes factors' to both bayesfactor_models() and bayesfactor_restricted() functions, explaining how to compare models using ratios of Bayes factors.
• Code Refactoring: Refactored the printing mechanism for Bayes factor matrices by renaming the S3 method print.bayesfactor_models_matrix to a more general print.bayesfactor_matrix, improving consistency across different Bayes factor matrix outputs.
• Version Update: The package version has been incremented from 0.17.0 to 0.17.0.1.

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. 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 introduces an as.matrix() method for bayesfactor_restricted objects and refactors the matrix representation for Bayes factors into a new bayesfactor_matrix class. The changes look good, improving consistency and functionality. I've found a minor typo in the NEWS.md file and a more significant documentation issue in both bayesfactor_models.R and bayesfactor_restricted.R where the description of the returned matrix from as.matrix() is inconsistent with the implementation. Correcting this documentation is important for users to correctly interpret the results.

[strengejacke]

Thanks! Can you add a small test?

[strengejacke]

LGTM, can be merged, unless you want to add/modify something.

[mattansb]

Thanks!