Feature: Introduce show_stats argument for enhanced control over displayed statistics
#46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs: Improve documentation, deprecate `show_percentage`, and update `geom_venn` This commit introduces several improvements to the documentation of the `ggvenn` package, deprecates the `show_percentage` argument in favor of the more versatile `show_stats` argument, and updates `geom_venn` to reflect the latest changes from @yanlinlin82. Key changes include: * **Added a ggvenn-package.R file:** This file provides a central location for package-level documentation. This is an automatic made for `usethis::use_lifecycle()` * **Enabled roxygen markdown:** Markdown support has been enabled in roxygen to improve the readability and formatting of documentation. * **Updated geom_venn.Rd:** The documentation for the `geom_venn` function has been updated to reflect the deprecation of `show_percentage`, to incorporate changes from previous commits, and to include the latest updates from @yanlinlin82. * **Deprecated `show_percentage`:** The `show_percentage` argument has been deprecated in favor of the `show_stats` argument, which provides more flexibility in controlling the display of count and percentage information. * **Removed commented-out code:** Commented-out code has been removed to improve code clarity and maintainability.
This commit updates the snapshot tests for the `ggvenn` package to include the deprecation warning for the `show_percentage` argument. The `show_percentage` argument has been deprecated in favor of the more versatile `show_stats` argument. This update ensures that the snapshot tests accurately reflect the current behavior of the package, including the warning message that is displayed when using the deprecated argument. The updated snapshots now include the following warning: ``` Warning <lifecycle_warning_deprecated> The `show_percentage` argument of `ggvenn()` is deprecated as of ggvenn 0.1.11. i Please use the `show_stats` argument instead. ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces the new
show_statsargument to theggvennfunction, providing users with more granular control over the statistics displayed within Venn diagrams. This addresses several open issues and offers a more versatile and intuitive approach compared to the deprecatedshow_percentageargument.Users can now choose to display either the count (
c), percentage (p), or both (cp) for each set in the Venn diagram. This allows for greater customization and tailoring of the output to specific needs.Example usage:
Related issues: #5, #26, #29, PR #45 (Addresses the
scaleswarning - see below)Note on
scaleswarning:This pull request does not directly address the
scaleswarning mentioned in PR #45.In summary, this pull request introduces a significant improvement to the
ggvennpackage by providing a more flexible and user-friendly way to control the display of statistics within Venn diagrams. It resolves existing issues, enhances clarity, and paves the way for future enhancements.Thank you for considering this contribution!