Rename cor into correlation_matrix

[strengejacke]

See easystats/performance#793 (comment)

[gemini-code-assist]

Summary of Changes

Hello @strengejacke, 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 focuses on enhancing code clarity and consistency within the statistical functions by renaming the cor parameter to the more descriptive correlation_matrix. This change is applied across function definitions, internal logic, and user-facing documentation, making the parameter's purpose more explicit.

Highlights

• Parameter Renaming: The cor parameter has been consistently renamed to correlation_matrix across the factor_analysis, n_factors, and n_components functions, as well as their internal helper functions and calls.
• Codebase Updates: All internal logic, conditional checks, and function calls that previously utilized the cor parameter have been updated to correctly reference correlation_matrix.
• Documentation Alignment: The Roxygen documentation files (.Rd) for n_factors and principal_components have been updated to reflect the new correlation_matrix parameter name and its detailed description, ensuring consistency 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 is currently in preview and 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 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. ↩

[gemini-code-assist]

Code Review

This pull request renames the cor argument to correlation_matrix in the factor_analysis and n_factors functions to improve clarity. There are a couple of instances where the renaming was missed and I've pointed those out.

[strengejacke]

@gemini-code-assist review

[gemini-code-assist]

Code Review

This pull request successfully renames the cor argument to correlation_matrix in n_factors and refactors factor_analysis to avoid argument collisions, enhancing flexibility by allowing direct argument passing to psych::fa. It also introduces valuable improvements to display and print methods, particularly for PCA/EFA objects, by refactoring for better maintainability and adding new HTML output capabilities. Documentation and tests are well-updated to reflect these changes. Overall, the changes are robust and improve the codebase. Several low to medium severity issues were identified, mostly related to maintainability and consistency.

[gemini-code-assist]

This error message is now referring to correlation_matrix instead of cor. Consider updating the message to reflect this change.

      "Please input the correlation matrix via the `correlation_matrix` argument and the number of rows / observations via the first argument." # nolint